Contact Us 1-800-596-4880
  1. Homepage
  2. D2L Brightspace Connector (0.1)

  3. D2L Brightspace Connector Reference

All Connectors

D2L Brightspace Connector 0.1.0 Reference

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

Configurations

Config

Default configuration.

Parameters

Name Type Description Default Value Required

Name

String

Name for this configuration. Connectors reference the configuration with this name.

x

Connection

OAuth 2.0

The connection types to provide to this configuration.

x

Name

String

ID used to reference this configuration.

x

Expiration Policy

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

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, Configuring OAuth 2.0 for Connectors on CloudHub, or OAuth Support in the SDK.

Parameters
Name Type Description Default Value Required

baseUri

String

Base URI for the D2L API.

x

TLS Configuration

TLS

Configures TLS. If using the HTTPS protocol, you must configure TLS.

Reconnection

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Consumer Key

String

OAuth consumer key, as registered with the service provider.

x

Consumer Secret

String

OAuth consumer secret, as registered with the service provider.

x

Authorization Url

String

URL of the service provider’s authorization endpoint.

https://auth.brightspace.com/oauth2/auth

Access Token Url

String

URL of the service provider’s access token endpoint.

https://auth.brightspace.com/core/connect/token

Scopes

String

OAuth scopes to request during the OAuth dance. This value defaults to the scopes in the annotation.

core:*:* role:detail:read grades:gradevalues:read grades:gradeobjects:read

Resource Owner Id

String

Resource owner ID to use with the authorization code grant type.

Before

String

The name of a flow to execute right before starting the OAuth dance.

After

String

The name of a flow to execute right after an access token has been received.

Auth Server Tls Context

TLS

References a TLS config to use for HTTP requests during the OAuth dance.

Auth Server Proxy Config

Any

References the proxy configuration through which the HTTP request is sent during the OAuth dance.

Listener Config

String

Configuration for the HTTP listener that listens for requests on the access token callback endpoint.

x

Callback Path

String

Path of the access token callback endpoint.

x

Authorize Path

String

Path of the local HTTP endpoint that triggers the OAuth dance.

x

External Callback Url

String

URL that the OAuth provider uses to access the callback endpoint if the endpoint is behind a proxy or accessed through an indirect URL.

Object Store

String

Configures the object store that stores data for each resource owner. If not configured, Mule uses the default object store.

Supported Operations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgUnitId

String

Organizational unit identifier.

x

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Array of Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

correlationId

String

Correlation ID for request tracing.

body

Any

Request body payload for the operation.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgUnitId

String

Organizational unit identifier.

x

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Null

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgUnitId

String

Organizational unit identifier.

x

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

correlationId

String

Correlation ID for request tracing.

body

Any

Request body payload for the operation.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgUnitId

String

Organizational unit identifier.

x

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Null

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgUnitId

String

Organizational unit identifier.

x

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

correlationId

String

Correlation ID for request tracing.

body

Any

Request body payload for the operation.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

correlationId

String

Correlation ID for request tracing.

body

Array of Any

Request body payload for the operation.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Array of Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgUnitId

String

Organizational unit identifier.

x

userId

String

User identifier.

x

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgUnitId

String

Organizational unit identifier.

x

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Array of Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgUnitId

String

Organizational unit identifier.

x

userId

String

User identifier.

x

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgUnitId

String

Organizational unit identifier.

x

roleId

Number

Role identifier.

isActive

Boolean

Whether to filter by active enrollment status.

false

bookmark

String

Bookmark for pagination.

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

userId

String

User identifier.

x

orgUnitTypeId

String

Organizational unit type identifier.

roleId

Number

Role identifier.

bookmark

String

Bookmark for pagination.

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgUnitId

String

Organizational unit identifier.

x

startDateTime

String

Start of the date-time range for the query.

x

endDateTime

String

End of the date-time range for the query.

x

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

userId

String

User identifier.

x

startExpiry

String

Start of the expiry date range for filtering.

endExpiry

String

End of the expiry date range for filtering.

bookmark

String

Bookmark for pagination.

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgUnitId

String

Organizational unit identifier.

x

userId

String

User identifier.

startExpiry

String

Start of the expiry date range for filtering.

endExpiry

String

End of the expiry date range for filtering.

bookmark

String

Bookmark for pagination.

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgUnitId

String

Organizational unit identifier.

x

gradeObjectId

String

Grade object identifier.

x

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgUnitId

String

Organizational unit identifier.

x

userId

String

User identifier.

x

gradeType

String

Type of grade to retrieve.

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgUnitId

String

Organizational unit identifier.

x

sort

String

Sort order for the results.

pageSize

Number

Number of results per page.

isGraded

Boolean

Whether to filter by graded status.

false

searchText

String

Text to search for in the results.

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

userId

String

User identifier.

x

modifiedSince

String

Filter results modified since this date-time.

pageSize

Number

Number of results per page.

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgUnitId

String

Organizational unit identifier.

x

gradeObjectId

String

Grade object identifier.

x

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgUnitId

String

Organizational unit identifier.

x

gradeObjectId

String

Grade object identifier.

x

userId

String

User identifier.

x

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

correlationId

String

Correlation ID for request tracing.

body

Any

Request body payload for the operation.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgUnitId

String

Organizational unit identifier.

x

childOrgUnitId

String

Child organizational unit identifier.

x

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Null

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgUnitId

String

Organizational unit identifier.

x

parentOrgUnitId

String

Parent organizational unit identifier.

x

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Null

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgUnitId

String

Organizational unit identifier.

x

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgUnitId

String

Organizational unit identifier.

x

ouTypeId

String

Organizational unit type identifier for filtering.

bookmark

String

Bookmark for pagination.

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Array of Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgUnitId

String

Organizational unit identifier.

x

ouTypeId

String

Organizational unit type identifier for filtering.

bookmark

String

Bookmark for pagination.

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgUnitId

String

Organizational unit identifier.

x

correlationId

String

Correlation ID for request tracing.

body

Any

Request body payload for the operation.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

deepCopyRoleId

String

Role identifier to deep copy from.

correlationId

String

Correlation ID for request tracing.

body

Any

Request body payload for the operation.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

roleId

String

Role identifier.

x

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgUnitId

String

Organizational unit identifier.

x

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Array of Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Array of Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

userId

String

User identifier.

x

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

* Array of Null * Null

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

userId

String

User identifier.

x

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

userId

String

User identifier.

x

correlationId

String

Correlation ID for request tracing.

body

Any

Request body payload for the operation.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

correlationId

String

Correlation ID for request tracing.

body

Any

Request body payload for the operation.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

correlationId

String

Correlation ID for request tracing.

body

Array of Any

Request body payload for the operation.

x

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

userId

String

User identifier.

x

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Null

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

orgDefinedId

String

Organization-defined user identifier.

userName

String

User name for filtering.

externalEmail

String

External email address for filtering.

bookmark

String

Bookmark for pagination.

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

userId

String

User identifier.

x

correlationId

String

Correlation ID for request tracing.

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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

Name Type Description Default Value Required

Configuration

String

Name of the configuration to use.

x

apiVersion

String

D2L API version to use for the request.

x

userId

String

User identifier.

x

correlationId

String

Correlation ID for request tracing.

body

Any

Request body payload for the operation.

#[payload]

Config Ref

ConfigurationProvider

Name of the configuration to use to execute this component.

x

Target Variable

String

Name of the variable in which the operation’s output will be placed.

Target Value

String

An expression to evaluate against the operation’s output and store the expression outcome in the target variable.

#[payload]

Error Mappings

Array of Error Mapping

Set of error mappings.

Output

Type

Any

Attributes Type

Any

For Configurations

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.

Field Type Description Default Value Required

Enabled Protocols

String

Comma-separated list of protocols enabled for this context.

Enabled Cipher Suites

String

Comma-separated list of cipher suites enabled for this context.

Trust Store

Truststore

Configures the TLS truststore.

Key Store

Keystore

Configures the TLS keystore.

Revocation Check

Configures a revocation checking mechanism.

Truststore

Configures the truststore for TLS.

Field Type Description Default Value Required

Path

String

Path to the truststore. Mule resolves the path relative to the current classpath and file system.

Password

String

Password used to protect the truststore.

Type

String

Type of store.

Algorithm

String

Encryption algorithm that the truststore uses.

Insecure

Boolean

If true, Mule stops performing certificate validations. Setting this to true can make connections vulnerable to attacks.

Keystore

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

Field Type Description Default Value Required

Path

String

Path to the keystore. Mule resolves the path relative to the current classpath and file system.

Type

String

Type of store.

Alias

String

Alias of the key to use when the keystore contains multiple private keys. By default, Mule uses the first key in the file.

Key Password

String

Password used to protect the private key.

Password

String

Password used to protect the keystore.

Algorithm

String

Encryption algorithm that the keystore uses.

Standard Revocation Check

Configures standard revocation checks for TLS certificates.

Field Type Description Default Value Required

Only End Entities

Boolean

Which elements to verify in the certificate chain:

  • true

Verify only the last element in the certificate chain.

  • false

Verify all elements in the certificate chain.

Prefer Crls

Boolean

How to check certificate validity:

  • true

Check the Certification Revocation List (CRL) for certificate validity.

  • false

Use the Online Certificate Status Protocol (OCSP) to check certificate validity.

No Fallback

Boolean

Whether to use the secondary method to check certificate validity:

  • true

Use the method that wasn’t specified in the Prefer Crls field (the secondary method) to check certificate validity.

  • false

Do not use the secondary method to check certificate validity.

Soft Fail

Boolean

What to do if the revocation server can’t be reached or is busy:

  • true

Avoid verification failure.

  • false

Allow the verification to fail.

Custom OCSP Responder

Configures a custom OCSP responder for certification revocation checks.

Field Type Description Default Value Required

Url

String

URL of the OCSP responder.

Cert Alias

String

Alias of the signing certificate for the OCSP response. If specified, the alias must be in the truststore.

CRL File

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

Field Type Description Default Value Required

Path

String

Path to the CRL file.

Reconnection

Configures a reconnection strategy for an operation.

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

Reconnection strategy to use.

Reconnect

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

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Count

Number

How many reconnection attempts the Mule app can make.

Reconnect Forever

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

Field Type Description Default Value Required

Frequency

Number

How often to attempt to reconnect, in milliseconds.

Blocking

Boolean

If false, the reconnection strategy runs in a separate, non-blocking thread.

Expiration Policy

Configures an expiration policy strategy.

Field Type Description Default Value Required

Max Idle Time

Number

Configures the maximum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

Time unit for the Max Idle Time field.

Error Mapping

Field Type Description Default Value Required

Source

Enumeration, one of:

  • ANY

  • REDELIVERY_EXHAUSTED

  • TRANSFORMATION

  • EXPRESSION

  • SECURITY

  • CLIENT_SECURITY

  • SERVER_SECURITY

  • ROUTING

  • CONNECTIVITY

  • RETRY_EXHAUSTED

  • TIMEOUT

Error type to map from.

Target

String

Error type to map to.

x
Back to top