# mulesoft D2L Brightspace Connector - Full Documentation

<!-- document id=785d044c2bc01d3ccef1fc91bc7af9328abdceb852d8e2c331d0be78ff26b720 url=/mulesoft/current/en-us/d2l-brightspace-connector/latest/index.md -->

---
product: D2L Brightspace Connector
version: 0.1
is-latest-version: true
---

# D2L Brightspace Connector 0.1.0

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for D2L Brightspace (D2L Brightspace Connector) enables Mule applications to
access the D2L Brightspace API.

> [!NOTE] D2L Brightspace 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 D2L Brightspace Connector Release
Notes.

## Before You Begin

To use this connector, you must be familiar with:

- The D2L Brightspace 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 D2L Brightspace 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)

- [D2L Brightspace Connector Reference](https://docs.mulesoft.com/d2l-brightspace-connector/latest/d2l-brightspace-connector-reference)

- [Salesforce Help](https://help.salesforce.com)

<!-- document id=8f3f6008984f4b583d52e3d0f70a4c9d9cccd6f9080d9b9c98ff91b96026f8b1 url=/mulesoft/current/en-us/d2l-brightspace-connector/latest/d2l-brightspace-connector-reference.md -->

---
product: D2L Brightspace Connector
version: 0.1
is-latest-version: true
---

# D2L Brightspace Connector 0.1.0 Reference

> For the full documentation index, see: https://docs.mulesoft.com/llms.txt

Anypoint Connector for D2L Brightspace (D2L Brightspace Connector) enables Mule applications to
access the Brightspace Learning Environment REST API.

## Configurations

---

### Config

Default configuration.

#### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Name</p></td><td><p>String</p></td><td><p>Name for this configuration. Connectors reference the configuration with this name.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Connection</p></td><td><div><div><p><a href="#Config_Oauth_2_0">OAuth 2.0</a></p></div></div></td><td><p>The connection types to provide to this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Name</p></td><td><div><div><p>String</p></div></div></td><td><p>ID used to reference this configuration.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Expiration Policy</p></td><td><div><div><p><a href="#ExpirationPolicy">Expiration Policy</a></p></div></div></td><td><p>Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.</p></td><td></td><td></td></tr></tbody></table>

#### 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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>baseUri</p></td><td><div><div><p>String</p></div></div></td><td><p>Base URI for the D2L API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>TLS Configuration</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>Configures TLS. If using the HTTPS protocol, you must configure TLS.</p></td><td></td><td></td></tr><tr><td><p>Reconnection</p></td><td><div><div><p><a href="#reconnection">Reconnection</a></p></div></div></td><td><p>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.</p></td><td></td><td></td></tr><tr><td><p>Consumer Key</p></td><td><div><div><p>String</p></div></div></td><td><p>OAuth consumer key, as registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Consumer Secret</p></td><td><div><div><p>String</p></div></div></td><td><p>OAuth consumer secret, as registered with the service provider.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Authorization Url</p></td><td><div><div><p>String</p></div></div></td><td><p>URL of the service provider’s authorization endpoint.</p></td><td><p><code>https://auth.brightspace.com/oauth2/auth</code></p></td><td></td></tr><tr><td><p>Access Token Url</p></td><td><div><div><p>String</p></div></div></td><td><p>URL of the service provider’s access token endpoint.</p></td><td><p><code>https://auth.brightspace.com/core/connect/token</code></p></td><td></td></tr><tr><td><p>Scopes</p></td><td><div><div><p>String</p></div></div></td><td><p>OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.</p></td><td><p>core:*:* role:detail:read grades:gradevalues:read grades:gradeobjects:read</p></td><td></td></tr><tr><td><p>Resource Owner Id</p></td><td><div><div><p>String</p></div></div></td><td><p>Resource owner ID to use with the authorization code grant type.</p></td><td></td><td></td></tr><tr><td><p>Before</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a flow to execute right before starting the OAuth dance.</p></td><td></td><td></td></tr><tr><td><p>After</p></td><td><div><div><p>String</p></div></div></td><td><p>The name of a flow to execute right after an access token has been received.</p></td><td></td><td></td></tr><tr><td><p>Auth Server Tls Context</p></td><td><div><div><p><a href="#Tls">TLS</a></p></div></div></td><td><p>References a TLS config to use for HTTP requests during the OAuth dance.</p></td><td></td><td></td></tr><tr><td><p>Auth Server Proxy Config</p></td><td><div><div><p>Any</p></div></div></td><td><p>References the proxy configuration through which the HTTP request is sent during the OAuth dance.</p></td><td></td><td></td></tr><tr><td><p>Listener Config</p></td><td><div><div><p>String</p></div></div></td><td><p>Configuration for the HTTP listener that listens for requests on the access token callback endpoint.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Callback Path</p></td><td><div><div><p>String</p></div></div></td><td><p>Path of the access token callback endpoint.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Authorize Path</p></td><td><div><div><p>String</p></div></div></td><td><p>Path of the local HTTP endpoint that triggers the OAuth dance.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>External Callback Url</p></td><td><div><div><p>String</p></div></div></td><td><p>URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL.</p></td><td></td><td></td></tr><tr><td><p>Object Store</p></td><td><div><div><p>String</p></div></div></td><td><p>Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.</p></td><td></td><td></td></tr></tbody></table>

## Supported Operations

- [Assignment Groups Get Assignment Groups](#AssignmentGroupsGetAssignmentGroups)

- [Course Offering Create Course Offering](#CourseOfferingCreateCourseOffering)

- [Course Offering Delete Course Offering](#CourseOfferingDeleteCourseOffering)

- [Course Offering Get Course Offering](#CourseOfferingGetCourseOffering)

- [Course Template Create Course Template](#CourseTemplateCreateCourseTemplate)

- [Course Template Delete Course Template](#CourseTemplateDeleteCourseTemplate)

- [Course Template Get Course Template](#CourseTemplateGetCourseTemplate)

- [Enrollment Create Enrollment](#EnrollmentCreateEnrollment)

- [Enrollment Create Enrollments](#EnrollmentCreateEnrollments)

- [Enrollment Delete Enrollment By Orgunit](#EnrollmentDeleteEnrollmentByOrgunit)

- [Enrollment Get Classlist By Orgunit](#EnrollmentGetClassListByOrgunit)

- [Enrollment Get Enrollment By Orgunit](#EnrollmentGetEnrollmentByOrgunit)

- [Enrollment Get Enrollments By Orgunit](#EnrollmentGetEnrollmentsByOrgunit)

- [Enrollment Get Users Enrollments](#EnrollmentGetUsersEnrollments)

- [Event Student Activity](#EventStudentActivity)

- [Grades Get A Users Course Completions](#GradesGetAUsersCourseCompletions)

- [Grades Get Course Completions](#GradesGetCourseCompletions)

- [Grades Get Grade Object](#GradesGetGradeObject)

- [Grades Get Users Final Grade](#GradesGetUsersFinalGrade)

- [Grades Get Users Final Grades](#GradesGetUsersFinalGrades)

- [Grades Get Users Grades](#GradesGetUsersGrades)

- [Grades Get Users Grades By Grade Object](#GradesGetUsersGradesByGadeObject)

- [Grades Get Users Grade By Gradeobject](#GradesGetUsersgradebyGradeObject)

- [Orgunit Create Orgunit](#OrgunitCreateOrgunit)

- [Orgunit Delete Orgunit Child Relationship](#OrgunitDeleteOrgunitChildRelationship)

- [Orgunit Delete Orgunit Parent Relationship](#OrgunitDeleteOrgunitParentRelationship)

- [Orgunit Get Orgunit](#OrgunitGetOrgunit)

- [Orgunit Get Orgunit Ancestors](#OrgunitGetOrgunitAncestors)

- [Orgunit Get Orgunit Children](#OrgunitGetOrgunitChildren)

- [Orgunit Update Orgunit](#OrgunitUpdateOrgunit)

- [Roles Create Role](#RolesCreateRole)

- [Roles Get Role](#RolesGetRole)

- [Roles Get Role By Orgunit](#RolesGetRoleByOrgunit)

- [Roles Get Roles](#RolesGetRoles)

- [User Attributes Delete User Attributes](#UserAttributesDeleteUserAttributes)

- [User Attributes Get User Attributes](#UserAttributesGetUserAttributes)

- [User Attributes Update User Attributes](#UserAttributesUpdateUserAttributes)

- [User Create User](#UserCreateUser)

- [User Create Users](#UserCreateUsers)

- [User Delete User](#UserDeleteUser)

- [User Get Users](#UserGetUsers)

- [User Get User](#UserGetuser)

- [User Update User](#UserUpdateUser)

## Operations

## Assignment Groups Get Assignment Groups

`<d2l:assignment-groups-get-assignment-groups>`

Retrieves assignment groups for the provided organizational unit (Brightspace Learning Environment
API).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Course Offering Create Course Offering

`<d2l:course-offering-create-course-offering>`

Creates a new course offering.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Request body payload for the operation.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Course Offering Delete Course Offering

`<d2l:course-offering-delete-course-offering>`

Deletes a course offering.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Null</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Course Offering Get Course Offering

`<d2l:course-offering-get-course-offering>`

Retrieves a course offering.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Course Template Create Course Template

`<d2l:course-template-create-course-template>`

Creates a new course template.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Request body payload for the operation.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Course Template Delete Course Template

`<d2l:course-template-delete-course-template>`

Deletes a course template.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Null</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Course Template Get Course Template

`<d2l:course-template-get-course-template>`

Retrieves a course template.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Enrollment Create Enrollment

`<d2l:enrollment-create-enrollment>`

Creates or updates an enrollment for a user.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Request body payload for the operation.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Enrollment Create Enrollments

`<d2l:enrollment-create-enrollments>`

Creates a batch of new enrollments for users.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>body</p></td><td><div><div><p>Array of Any</p></div></div></td><td><p>Request body payload for the operation.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Enrollment Delete Enrollment By Orgunit

`<d2l:enrollment-delete-enrollment-by-orgunit>`

Deletes a user’s enrollment in a provided organizational unit.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>userId</p></td><td><div><div><p>String</p></div></div></td><td><p>User identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Enrollment Get Classlist By Orgunit

`<d2l:enrollment-get-class-list-by-orgunit>`

Retrieves the enrolled users in the classlist for an organizational unit.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Enrollment Get Enrollment By Orgunit

`<d2l:enrollment-get-enrollment-by-orgunit>`

Retrieves enrollment details for a user in the provided organizational unit.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>userId</p></td><td><div><div><p>String</p></div></div></td><td><p>User identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Enrollment Get Enrollments By Orgunit

`<d2l:enrollment-get-enrollments-by-orgunit>`

Retrieves the collection of users enrolled in the identified organizational unit.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>roleId</p></td><td><div><div><p>Number</p></div></div></td><td><p>Role identifier.</p></td><td></td><td></td></tr><tr><td><p>isActive</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to filter by active enrollment status.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>bookmark</p></td><td><div><div><p>String</p></div></div></td><td><p>Bookmark for pagination.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Enrollment Get Users Enrollments

`<d2l:enrollment-get-users-enrollments>`

Retrieves a list of all enrollments for the provided user.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>userId</p></td><td><div><div><p>String</p></div></div></td><td><p>User identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitTypeId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit type identifier.</p></td><td></td><td></td></tr><tr><td><p>roleId</p></td><td><div><div><p>Number</p></div></div></td><td><p>Role identifier.</p></td><td></td><td></td></tr><tr><td><p>bookmark</p></td><td><div><div><p>String</p></div></div></td><td><p>Bookmark for pagination.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Event Student Activity

`<d2l:event-student-activity>`

Retrieves student activity for the organizational unit within the specified date-time range
(Brightspace Learning Environment API).

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>startDateTime</p></td><td><div><div><p>String</p></div></div></td><td><p>Start of the date-time range for the query.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>endDateTime</p></td><td><div><div><p>String</p></div></div></td><td><p>End of the date-time range for the query.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Grades Get A Users Course Completions

`<d2l:grades-get-a-users-course-completions>`

Retrieves all course completion records for a user.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>userId</p></td><td><div><div><p>String</p></div></div></td><td><p>User identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>startExpiry</p></td><td><div><div><p>String</p></div></div></td><td><p>Start of the expiry date range for filtering.</p></td><td></td><td></td></tr><tr><td><p>endExpiry</p></td><td><div><div><p>String</p></div></div></td><td><p>End of the expiry date range for filtering.</p></td><td></td><td></td></tr><tr><td><p>bookmark</p></td><td><div><div><p>String</p></div></div></td><td><p>Bookmark for pagination.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Grades Get Course Completions

`<d2l:grades-get-course-completions>`

Retrieves all course completion records for an organizational unit.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>userId</p></td><td><div><div><p>String</p></div></div></td><td><p>User identifier.</p></td><td></td><td></td></tr><tr><td><p>startExpiry</p></td><td><div><div><p>String</p></div></div></td><td><p>Start of the expiry date range for filtering.</p></td><td></td><td></td></tr><tr><td><p>endExpiry</p></td><td><div><div><p>String</p></div></div></td><td><p>End of the expiry date range for filtering.</p></td><td></td><td></td></tr><tr><td><p>bookmark</p></td><td><div><div><p>String</p></div></div></td><td><p>Bookmark for pagination.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Grades Get Grade Object

`<d2l:grades-get-grade-object>`

Retrieves a specific grade object for a particular organizational unit.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>gradeObjectId</p></td><td><div><div><p>String</p></div></div></td><td><p>Grade object identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Grades Get Users Final Grade

`<d2l:grades-get-users-final-grade>`

Retrieves the final grade value for a particular user.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>userId</p></td><td><div><div><p>String</p></div></div></td><td><p>User identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>gradeType</p></td><td><div><div><p>String</p></div></div></td><td><p>Type of grade to retrieve.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Grades Get Users Final Grades

`<d2l:grades-get-users-final-grades>`

Retrieves each user’s final grade value for a particular organizational unit.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>sort</p></td><td><div><div><p>String</p></div></div></td><td><p>Sort order for the results.</p></td><td></td><td></td></tr><tr><td><p>pageSize</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of results per page.</p></td><td></td><td></td></tr><tr><td><p>isGraded</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to filter by graded status.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>searchText</p></td><td><div><div><p>String</p></div></div></td><td><p>Text to search for in the results.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Grades Get Users Grades

`<d2l:grades-get-users-grades>`

Retrieves all grade values for a particular user assigned in an organizational unit.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>userId</p></td><td><div><div><p>String</p></div></div></td><td><p>User identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>modifiedSince</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter results modified since this date-time.</p></td><td></td><td></td></tr><tr><td><p>pageSize</p></td><td><div><div><p>Number</p></div></div></td><td><p>Number of results per page.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Grades Get Users Grades By Grade Object

`<d2l:grades-get-users-grades-by-gade-object>`

Retrieves each user’s grade value for a particular grade object.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>gradeObjectId</p></td><td><div><div><p>String</p></div></div></td><td><p>Grade object identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Grades Get Users Grade By Gradeobject

`<d2l:grades-get-usersgradeby-grade-object>`

Retrieves a user’s grade value for a particular grade object.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>gradeObjectId</p></td><td><div><div><p>String</p></div></div></td><td><p>Grade object identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>userId</p></td><td><div><div><p>String</p></div></div></td><td><p>User identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Orgunit Create Orgunit

`<d2l:orgunit-create-orgunit>`

Creates a new custom organizational unit.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Request body payload for the operation.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Orgunit Delete Orgunit Child Relationship

`<d2l:orgunit-delete-orgunit-child-relationship>`

Deletes the relationship between a provided organizational unit and one of its children.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>childOrgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Child organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Null</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Orgunit Delete Orgunit Parent Relationship

`<d2l:orgunit-delete-orgunit-parent-relationship>`

Deletes the relationship between a provided organizational unit and one of its parents.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>parentOrgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Parent organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Null</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Orgunit Get Orgunit

`<d2l:orgunit-get-orgunit>`

Retrieves the properties for a provided organizational unit.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Orgunit Get Orgunit Ancestors

`<d2l:orgunit-get-orgunit-ancestors>`

Retrieves a list of ancestor organizational units for a provided organizational unit.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>ouTypeId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit type identifier for filtering.</p></td><td></td><td></td></tr><tr><td><p>bookmark</p></td><td><div><div><p>String</p></div></div></td><td><p>Bookmark for pagination.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Orgunit Get Orgunit Children

`<d2l:orgunit-get-orgunit-children>`

Retrieves a list of child organizational units for a provided organizational unit.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>ouTypeId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit type identifier for filtering.</p></td><td></td><td></td></tr><tr><td><p>bookmark</p></td><td><div><div><p>String</p></div></div></td><td><p>Bookmark for pagination.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Orgunit Update Orgunit

`<d2l:orgunit-update-orgunit>`

Updates a custom organizational unit’s properties.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Request body payload for the operation.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Roles Create Role

`<d2l:roles-create-role>`

Creates a new user role.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>deepCopyRoleId</p></td><td><div><div><p>String</p></div></div></td><td><p>Role identifier to deep copy from.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Request body payload for the operation.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Roles Get Role

`<d2l:roles-get-role>`

Retrieves a user role.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>roleId</p></td><td><div><div><p>String</p></div></div></td><td><p>Role identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Roles Get Role By Orgunit

`<d2l:roles-get-role-by-orgunit>`

Retrieves user roles for the organizational unit.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgUnitId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organizational unit identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Roles Get Roles

`<d2l:roles-get-roles>`

Retrieves all user roles.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Array of Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## User Attributes Delete User Attributes

`<d2l:user-attributes-delete-user-attributes>`

Deletes custom user attribute values for a user.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>userId</p></td><td><div><div><p>String</p></div></div></td><td><p>User identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>* Array of Null * Null</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## User Attributes Get User Attributes

`<d2l:user-attributes-get-user-attributes>`

Retrieves user attributes for a user.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>userId</p></td><td><div><div><p>String</p></div></div></td><td><p>User identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## User Attributes Update User Attributes

`<d2l:user-attributes-update-user-attributes>`

Updates user attributes for a user.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>userId</p></td><td><div><div><p>String</p></div></div></td><td><p>User identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Request body payload for the operation.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## User Create User

`<d2l:user-create-user>`

Creates a new user entity.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Request body payload for the operation.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## User Create Users

`<d2l:user-create-users>`

Creates a batch of new user entities.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>body</p></td><td><div><div><p>Array of Any</p></div></div></td><td><p>Request body payload for the operation.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## User Delete User

`<d2l:user-delete-user>`

Deletes a particular user.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>userId</p></td><td><div><div><p>String</p></div></div></td><td><p>User identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Null</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## User Get Users

`<d2l:user-get-users>`

Retrieves data for one or more users.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>orgDefinedId</p></td><td><div><div><p>String</p></div></div></td><td><p>Organization-defined user identifier.</p></td><td></td><td></td></tr><tr><td><p>userName</p></td><td><div><div><p>String</p></div></div></td><td><p>User name for filtering.</p></td><td></td><td></td></tr><tr><td><p>externalEmail</p></td><td><div><div><p>String</p></div></div></td><td><p>External email address for filtering.</p></td><td></td><td></td></tr><tr><td><p>bookmark</p></td><td><div><div><p>String</p></div></div></td><td><p>Bookmark for pagination.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## User Get User

`<d2l:user-getuser>`

Retrieves data for a particular user.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>userId</p></td><td><div><div><p>String</p></div></div></td><td><p>User identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## User Update User

`<d2l:user-update-user>`

Updates data for a particular user.

### Parameters

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Name</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p>Configuration</p></td><td><p>String</p></td><td><p>Name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>apiVersion</p></td><td><div><div><p>String</p></div></div></td><td><p>D2L API version to use for the request.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>userId</p></td><td><div><div><p>String</p></div></div></td><td><p>User identifier.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Correlation ID for request tracing.</p></td><td></td><td></td></tr><tr><td><p>body</p></td><td><div><div><p>Any</p></div></div></td><td><p>Request body payload for the operation.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Config Ref</p></td><td><div><div><p>ConfigurationProvider</p></div></div></td><td><p>Name of the configuration to use to execute this component.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>Target Variable</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the variable in which the operation’s output will be placed.</p></td><td></td><td></td></tr><tr><td><p>Target Value</p></td><td><div><div><p>String</p></div></div></td><td><p>An expression to evaluate against the operation’s output and store the expression outcome in the target variable.</p></td><td><p>#[payload]</p></td><td></td></tr><tr><td><p>Error Mappings</p></td><td><div><div><p>Array of <a href="#ErrorMapping">Error Mapping</a></p></div></div></td><td><p>Set of error mappings.</p></td><td></td><td></td></tr></tbody></table>

### Output

<table><colgroup><col> <col></colgroup><tbody><tr><td><p>Type</p></td><td><p>Any</p></td></tr><tr><td><p>Attributes Type</p></td><td><div><div><p>Any</p></div></div></td></tr></tbody></table>

### For Configurations

- [Config](#Config)

### Throws

- D2L:BAD\_REQUEST

- D2L:CLIENT\_ERROR

- D2L:CONNECTIVITY

- D2L:FORBIDDEN

- D2L:INTERNAL\_SERVER\_ERROR

- D2L:NOT\_FOUND

- D2L:SECURITY

- D2L:SERVER\_ERROR

- D2L:TIMEOUT

- D2L:UNAUTHORIZED

## Types

### TLS

Configures TLS to provide secure communications for the Mule app.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Enabled Protocols</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of protocols enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Enabled Cipher Suites</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Comma-separated list of cipher suites enabled for this context.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Trust Store</strong></p></td><td><div><div><p><a href="#TrustStore">Truststore</a></p></div></div></td><td><div><div><p>Configures the TLS truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Store</strong></p></td><td><div><div><p><a href="#KeyStore">Keystore</a></p></div></div></td><td><div><div><p>Configures the TLS keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Revocation Check</strong></p></td><td><div><div><ul><li><p><a href="#StandardRevocationCheck">Standard Revocation Check</a></p></li><li><p><a href="#CustomOcspResponder">Custom OCSP Responder</a></p></li><li><p><a href="#CrlFile">CRL File</a></p></li></ul></div></div></td><td><div><div><p>Configures a revocation checking mechanism.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Truststore

Configures the truststore for TLS.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the truststore. Mule resolves the path relative to the current classpath and file system.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encryption algorithm that the truststore uses.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Insecure</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>true</code>, Mule stops performing certificate validations. Setting this to <code>true</code> can make connections vulnerable to attacks.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Keystore

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the keystore. Mule resolves the path relative to the current classpath and file system.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Type</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Type of store.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Key Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the private key.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Password</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Password used to protect the keystore.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Algorithm</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Encryption algorithm that the keystore uses.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Standard Revocation Check

Configures standard revocation checks for TLS certificates.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Only End Entities</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Which elements to verify in the certificate chain:</p></div><div><ul><li><p><code>true</code></p></li></ul></div><div><p>Verify only the last element in the certificate chain.</p></div><div><ul><li><p><code>false</code></p></li></ul></div><div><p>Verify all elements in the certificate chain.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Prefer Crls</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>How to check certificate validity:</p></div><div><ul><li><p><code>true</code></p></li></ul></div><div><p>Check the Certification Revocation List (CRL) for certificate validity.</p></div><div><ul><li><p><code>false</code></p></li></ul></div><div><p>Use the Online Certificate Status Protocol (OCSP) to check certificate validity.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>No Fallback</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>Whether to use the secondary method to check certificate validity:</p></div><div><ul><li><p><code>true</code></p></li></ul></div><div><p>Use the method that wasn’t specified in the <strong>Prefer Crls</strong> field (the secondary method) to check certificate validity.</p></div><div><ul><li><p><code>false</code></p></li></ul></div><div><p>Do not use the secondary method to check certificate validity.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Soft Fail</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>What to do if the revocation server can’t be reached or is busy:</p></div><div><ul><li><p><code>true</code></p></li></ul></div><div><p>Avoid verification failure.</p></div><div><ul><li><p><code>false</code></p></li></ul></div><div><p>Allow the verification to fail.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Url</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>URL of the OCSP responder.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Cert Alias</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### CRL File

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

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Path</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Path to the CRL file.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnection

Configures a reconnection strategy for an operation.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Fails Deployment</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>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.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Reconnection Strategy</strong></p></td><td><div><div><ul><li><p><a href="#reconnect">Reconnect</a></p></li><li><p><a href="#ReconnectForever">Reconnect Forever</a></p></li></ul></div></div></td><td><div><div><p>Reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect

Configures a standard reconnection strategy, which specifies how often to reconnect and how many
reconnection attempts the connector source or operation can make.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Count</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How many reconnection attempts the Mule app can make.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Frequency</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>How often to attempt to reconnect, in milliseconds.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Blocking</strong></p></td><td><div><div><p>Boolean</p></div></div></td><td><div><div><p>If <code>false</code>, the reconnection strategy runs in a separate, non-blocking thread.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Expiration Policy

Configures an expiration policy strategy.

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Max Idle Time</strong></p></td><td><div><div><p>Number</p></div></div></td><td><div><div><p>Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Time Unit</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>NANOSECONDS</p></li><li><p>MICROSECONDS</p></li><li><p>MILLISECONDS</p></li><li><p>SECONDS</p></li><li><p>MINUTES</p></li><li><p>HOURS</p></li><li><p>DAYS</p></li></ul></div></div></td><td><div><div><p>Time unit for the <strong>Max Idle Time</strong> field.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Error Mapping

<table><colgroup><col> <col> <col> <col> <col></colgroup><thead><tr><th>Field</th><th>Type</th><th>Description</th><th>Default Value</th><th>Required</th></tr></thead><tbody><tr><td><p><strong>Source</strong></p></td><td><div><div><p>Enumeration, one of:</p></div><div><ul><li><p>ANY</p></li><li><p>REDELIVERY_EXHAUSTED</p></li><li><p>TRANSFORMATION</p></li><li><p>EXPRESSION</p></li><li><p>SECURITY</p></li><li><p>CLIENT_SECURITY</p></li><li><p>SERVER_SECURITY</p></li><li><p>ROUTING</p></li><li><p>CONNECTIVITY</p></li><li><p>RETRY_EXHAUSTED</p></li><li><p>TIMEOUT</p></li></ul></div></div></td><td><div><div><p>Error type to map from.</p></div></div></td><td><div></div></td><td><div></div></td></tr><tr><td><p><strong>Target</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>Error type to map to.</p></div></div></td><td><div></div></td><td><div><div><p>x</p></div></div></td></tr></tbody></table>