---
schema_version: "1"
id: 5c15b250eab2959c8a6a0ea20f9ac2fc4c6efba24dceb6ddcefa6db34e1c6eb6
title: Blackboard Connector 0.1.0 Reference
collection: mulesoft
version: current
locale: en-us
portal_url: https://docs.salesforce.com/mulesoft/current/en-us/blackboard-connector/0.1/blackboard-connector-reference.md
canonical_url: https://docs.mulesoft.com/blackboard-connector/0.1/blackboard-connector-reference
source_site: docs.mulesoft.com
content_type: documentation
content_hash: 93c1f9121ede5b8d6ac75d1ec2cbf94767ec455f41b56017fcd5edbd1684302b
description: MuleSoft Documentation Site
release: "0.1"
latest: false
---
---
product: Blackboard Connector
version: 0.1
---

# Blackboard Connector 0.1.0 Reference

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

Anypoint Connector for Blackboard (Blackboard Connector) enables Mule applications to access the
Blackboard Learn REST API.

## Configurations

---

### Config

Default configuration for the connector.

#### 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>The 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_Authorization">Authorization</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>The identifier of this element used to reference it in other components.</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. This does not mean that the platform expires the instance at the exact moment that it becomes eligible. Mule purges the instances as appropriate.</p></td><td></td><td></td></tr></tbody></table>

#### Connection Types

##### Authorization

###### 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 of the Blackboard Learn REST API.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>token</p></td><td><div><div><p>String</p></div></div></td><td><p>OAuth 2.0 access token used to authorize API requests.</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>TLS settings for HTTPS connections.</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></tbody></table>

## Supported Operations

- [Course Category Create Category](#CourseCategoryCreateCategory)

- [Course Category Create Category Membership](#CourseCategoryCreateCategoryMembership)

- [Course Category Delete Category](#CourseCategoryDeleteCategory)

- [Course Category Delete Category Membership](#CourseCategoryDeleteCategoryMembership)

- [Course Category Get Categories](#CourseCategoryGetCategories)

- [Course Category Get Category By ID](#CourseCategoryGetCategoryById)

- [Course Category Get Category Memberships](#CourseCategoryGetCategoryMemberships)

- [Course Category Get Child Categories](#CourseCategoryGetChildCategories)

- [Course Category Update Category](#CourseCategoryUpdateCategory)

- [Course Gradebook Get Column Grade](#CourseGradebookGetColumnGrade)

- [Course Gradebook Get Column Grades](#CourseGradebookGetColumnGrades)

- [Course Gradebook Get Grade Column](#CourseGradebookGetGradeColumn)

- [Course Gradebook Get Grade Columns](#CourseGradebookGetGradeColumns)

- [Course Gradebook Get Gradebook Categories](#CourseGradebookGetGradebookCategories)

- [Course Membership Create Course User Membership](#CourseMembershipCreateCourseUserMembership)

- [Course Membership Delete Course Membership](#CourseMembershipDeleteCourseMembership)

- [Course Membership Get Course Membership](#CourseMembershipGetCourseMembership)

- [Course Membership Get Course Memberships](#CourseMembershipGetCourseMemberships)

- [Course Membership Get User Memberships](#CourseMembershipGetUserMemberships)

- [Course Membership Update Course User Membership](#CourseMembershipUpdateCourseUserMembership)

- [Courses Add Child Course](#CoursesAddChildCourse)

- [Courses Create Course](#CoursesCreateCourse)

- [Courses Delete Course](#CoursesDeleteCourse)

- [Courses Get Course](#CoursesGetCourse)

- [Courses Get Course Child](#CoursesGetCourseChild)

- [Courses Get Course Children](#CoursesGetCourseChildren)

- [Courses Get Courses](#CoursesGetCourses)

- [Courses Remove Child Course](#CoursesRemoveChildCourse)

- [Courses Update Course](#CoursesUpdateCourse)

- [Roles Get Course Role](#RolesGetCourseRole)

- [Roles Get Course Roles](#RolesGetCourseRoles)

- [Roles Get Institution Role](#RolesGetInstitutionRole)

- [Roles Get Institution Roles](#RolesGetInstitutionRoles)

- [Terms Create Term](#TermsCreateTerm)

- [Terms Delete Term](#TermsDeleteTerm)

- [Terms Get Term](#TermsGetTerm)

- [Terms Get Terms](#TermsGetTerms)

- [Terms Update Term](#TermsUpdateTerm)

- [Token Access Token](#TokenAccessToken)

- [Users Create User](#UsersCreateUser)

- [Users Delete User](#UsersDeleteUser)

- [Users Get User](#UsersGetUser)

- [Users Get Users](#UsersGetUsers)

- [Users Update User](#UsersUpdateUser)

- [Users Upcoming Events](#UsersupcomingEvents)

## Operations

## Course Category Create Category

`<blackboard:course-category-create-category>`

Creates a course category of the given type in Blackboard Learn.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>categoryType</p></td><td><div><div><p>String</p></div></div></td><td><p>Course category type segment for the REST resource path.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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 for create or update operations.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Course Category Create Category Membership

`<blackboard:course-category-create-category-membership>`

Adds a course to a course category (creates a category membership).

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>categoryType</p></td><td><div><div><p>String</p></div></div></td><td><p>Course category type segment for the REST resource path.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>categoryId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course category ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>courseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Course Category Delete Category

`<blackboard:course-category-delete-category>`

Deletes a course category.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>categoryType</p></td><td><div><div><p>String</p></div></div></td><td><p>Course category type segment for the REST resource path.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>categoryId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course category ID.</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>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Course Category Delete Category Membership

`<blackboard:course-category-delete-category-membership>`

Removes a course from a course category (deletes the category membership).

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>categoryType</p></td><td><div><div><p>String</p></div></div></td><td><p>Course category type segment for the REST resource path.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>categoryId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course category ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>courseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course ID.</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>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Course Category Get Categories

`<blackboard:course-category-get-categories>`

Returns course categories for the specified category type.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>categoryType</p></td><td><div><div><p>String</p></div></div></td><td><p>Course category type segment for the REST resource path.</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>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Course Category Get Category By ID

`<blackboard:course-category-get-category-by-id>`

Returns a single course category by ID.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>categoryType</p></td><td><div><div><p>String</p></div></div></td><td><p>Course category type segment for the REST resource path.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>categoryId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course category ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Course Category Get Category Memberships

`<blackboard:course-category-get-category-memberships>`

Returns course memberships for a category (courses linked to that category).

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>categoryType</p></td><td><div><div><p>String</p></div></div></td><td><p>Course category type segment for the REST resource path.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>categoryId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course category ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>includePermissions</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to include permission metadata in the response.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>expand</p></td><td><div><div><p>String</p></div></div></td><td><p>Related resources to expand in the response.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>Zero-based index of the first item to return.</p></td><td></td><td></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of items to return.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Course Category Get Child Categories

`<blackboard:course-category-get-child-categories>`

Returns child categories under a parent category.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>categoryType</p></td><td><div><div><p>String</p></div></div></td><td><p>Course category type segment for the REST resource path.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>parentId</p></td><td><div><div><p>String</p></div></div></td><td><p>Parent category ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>categoryId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course category ID.</p></td><td></td><td></td></tr><tr><td><p>dataSourceId</p></td><td><div><div><p>String</p></div></div></td><td><p>Data source ID.</p></td><td></td><td></td></tr><tr><td><p>includePermissions</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to include permission metadata in the response.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>createdCompare</p></td><td><div><div><p>String</p></div></div></td><td><p>Comparison operator for the created timestamp filter.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>Zero-based index of the first item to return.</p></td><td></td><td></td></tr><tr><td><p>frontPage</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to restrict results to front-page categories.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>available</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether the resource is available.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>title</p></td><td><div><div><p>String</p></div></div></td><td><p>Title filter or value for the request.</p></td><td></td><td></td></tr><tr><td><p>sort</p></td><td><div><div><p>String</p></div></div></td><td><p>Sort order for the result set.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of items to return.</p></td><td></td><td></td></tr><tr><td><p>created</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter by resource creation timestamp.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Course Category Update Category

`<blackboard:course-category-update-category>`

Updates an existing course category.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>categoryType</p></td><td><div><div><p>String</p></div></div></td><td><p>Course category type segment for the REST resource path.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>categoryId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course category ID.</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>Optional client-supplied identifier for correlating requests.</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 for create or update operations.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Course Gradebook Get Column Grade

`<blackboard:course-gradebook-get-column-grade>`

Returns the grade for one user in a specific gradebook column.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>courseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>columnId</p></td><td><div><div><p>String</p></div></div></td><td><p>Gradebook column ID.</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 ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>unsupportedSearchOverChildCourses</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to search across child courses.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Course Gradebook Get Column Grades

`<blackboard:course-gradebook-get-column-grades>`

Returns grades for all users (or a filtered set) in a gradebook column.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>courseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>columnId</p></td><td><div><div><p>String</p></div></div></td><td><p>Gradebook column ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>firstRelevantDateCompare</p></td><td><div><div><p>String</p></div></div></td><td><p>Comparison operator for the firstRelevantDate filter.</p></td><td></td><td></td></tr><tr><td><p>lastRelevantDate</p></td><td><div><div><p>String</p></div></div></td><td><p>End of the relevant date range filter.</p></td><td></td><td></td></tr><tr><td><p>changeIndex</p></td><td><div><div><p>Number</p></div></div></td><td><p>Change index for optimistic concurrency control.</p></td><td></td><td></td></tr><tr><td><p>includeUnpostedGrades</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to include unposted grades in the response.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>firstRelevantDate</p></td><td><div><div><p>String</p></div></div></td><td><p>Start of the relevant date range filter.</p></td><td></td><td></td></tr><tr><td><p>includePermissions</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to include permission metadata in the response.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>includeDisabledMemberships</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to include disabled memberships in the response.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>Zero-based index of the first item to return.</p></td><td></td><td></td></tr><tr><td><p>lastRelevantDateCompare</p></td><td><div><div><p>String</p></div></div></td><td><p>Comparison operator for the lastRelevantDate filter.</p></td><td></td><td></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>unsupportedSearchOverChildCourses</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to search across child courses.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of items to return.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Course Gradebook Get Grade Column

`<blackboard:course-gradebook-get-grade-column>`

Returns metadata for a single gradebook column in a course.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>courseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>columnId</p></td><td><div><div><p>String</p></div></div></td><td><p>Gradebook column ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>expand</p></td><td><div><div><p>String</p></div></div></td><td><p>Related resources to expand in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Course Gradebook Get Grade Columns

`<blackboard:course-gradebook-get-grade-columns>`

Returns gradebook columns for a course.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>courseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>displayName</p></td><td><div><div><p>String</p></div></div></td><td><p>Display name of the resource.</p></td><td></td><td></td></tr><tr><td><p>name</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the resource.</p></td><td></td><td></td></tr><tr><td><p>includePermissions</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to include permission metadata in the response.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>createdCompare</p></td><td><div><div><p>String</p></div></div></td><td><p>Comparison operator for the created timestamp filter.</p></td><td></td><td></td></tr><tr><td><p>modifiedCompare</p></td><td><div><div><p>String</p></div></div></td><td><p>Comparison operator for the modified filter.</p></td><td></td><td></td></tr><tr><td><p>gradebookCategoryId</p></td><td><div><div><ul><li><p>Array of String</p></li><li><p>String</p></li></ul></div></div></td><td><p>Gradebook category ID or list of category IDs.</p></td><td></td><td></td></tr><tr><td><p>expand</p></td><td><div><div><p>String</p></div></div></td><td><p>Related resources to expand in the response.</p></td><td></td><td></td></tr><tr><td><p>modified</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter by last modified timestamp.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>Zero-based index of the first item to return.</p></td><td></td><td></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>contentId</p></td><td><div><div><p>String</p></div></div></td><td><p>Content item ID.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of items to return.</p></td><td></td><td></td></tr><tr><td><p>created</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter by resource creation timestamp.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Course Gradebook Get Gradebook Categories

`<blackboard:course-gradebook-get-gradebook-categories>`

Returns gradebook categories defined for a course.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>courseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>Zero-based index of the first item to return.</p></td><td></td><td></td></tr><tr><td><p>includePermissions</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to include permission metadata in the response.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of items to return.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Course Membership Create Course User Membership

`<blackboard:course-membership-create-course-user-membership>`

Enrolls a user in a course with a course role (creates a course membership).

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>courseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course ID.</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 ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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 for create or update operations.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Course Membership Delete Course Membership

`<blackboard:course-membership-delete-course-membership>`

Removes a user’s membership from a course.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>courseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course ID.</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 ID.</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>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Course Membership Get Course Membership

`<blackboard:course-membership-get-course-membership>`

Returns a specific user’s membership in a course.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>courseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course ID.</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 ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>expand</p></td><td><div><div><p>String</p></div></div></td><td><p>Related resources to expand in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Course Membership Get Course Memberships

`<blackboard:course-membership-get-course-memberships>`

Returns course memberships for a course (users enrolled in the course).

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>courseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>lastAccessed</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter by last accessed timestamp.</p></td><td></td><td></td></tr><tr><td><p>availability.available</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter by availability status.</p></td><td></td><td></td></tr><tr><td><p>role</p></td><td><div><div><p>String</p></div></div></td><td><p>Role filter for the request.</p></td><td></td><td></td></tr><tr><td><p>dataSourceId</p></td><td><div><div><p>String</p></div></div></td><td><p>Data source ID.</p></td><td></td><td></td></tr><tr><td><p>includePermissions</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to include permission metadata in the response.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>createdCompare</p></td><td><div><div><p>String</p></div></div></td><td><p>Comparison operator for the created timestamp filter.</p></td><td></td><td></td></tr><tr><td><p>modifiedCompare</p></td><td><div><div><p>String</p></div></div></td><td><p>Comparison operator for the modified filter.</p></td><td></td><td></td></tr><tr><td><p>lastAccessedCompare</p></td><td><div><div><p>String</p></div></div></td><td><p>Comparison operator for the lastAccessed filter.</p></td><td></td><td></td></tr><tr><td><p>expand</p></td><td><div><div><p>String</p></div></div></td><td><p>Related resources to expand in the response.</p></td><td></td><td></td></tr><tr><td><p>modified</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter by last modified timestamp.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>Zero-based index of the first item to return.</p></td><td></td><td></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>sort</p></td><td><div><div><p>String</p></div></div></td><td><p>Sort order for the result set.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of items to return.</p></td><td></td><td></td></tr><tr><td><p>created</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter by resource creation timestamp.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Course Membership Get User Memberships

`<blackboard:course-membership-get-user-memberships>`

Returns course memberships for a user across courses.

### 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>The name of the configuration to use.</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 ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>lastAccessed</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter by last accessed timestamp.</p></td><td></td><td></td></tr><tr><td><p>availability.available</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter by availability status.</p></td><td></td><td></td></tr><tr><td><p>role</p></td><td><div><div><p>String</p></div></div></td><td><p>Role filter for the request.</p></td><td></td><td></td></tr><tr><td><p>dataSourceId</p></td><td><div><div><p>String</p></div></div></td><td><p>Data source ID.</p></td><td></td><td></td></tr><tr><td><p>includePermissions</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to include permission metadata in the response.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>createdCompare</p></td><td><div><div><p>String</p></div></div></td><td><p>Comparison operator for the created timestamp filter.</p></td><td></td><td></td></tr><tr><td><p>modifiedCompare</p></td><td><div><div><p>String</p></div></div></td><td><p>Comparison operator for the modified filter.</p></td><td></td><td></td></tr><tr><td><p>lastAccessedCompare</p></td><td><div><div><p>String</p></div></div></td><td><p>Comparison operator for the lastAccessed filter.</p></td><td></td><td></td></tr><tr><td><p>expand</p></td><td><div><div><p>String</p></div></div></td><td><p>Related resources to expand in the response.</p></td><td></td><td></td></tr><tr><td><p>modified</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter by last modified timestamp.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>Zero-based index of the first item to return.</p></td><td></td><td></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>sort</p></td><td><div><div><p>String</p></div></div></td><td><p>Sort order for the result set.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of items to return.</p></td><td></td><td></td></tr><tr><td><p>created</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter by resource creation timestamp.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Course Membership Update Course User Membership

`<blackboard:course-membership-update-course-user-membership>`

Updates a user’s course membership (for example, course role or availability).

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>courseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course ID.</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 ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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 for create or update operations.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Courses Add Child Course

`<blackboard:courses-add-child-course>`

Links a child course to a parent course in a merged course hierarchy.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>courseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>childCourseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Child course ID in a course merge hierarchy.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>ignoreEnrollmentErrors</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to ignore enrollment errors during the operation.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Courses Create Course

`<blackboard:courses-create-course>`

Creates a new course in Blackboard Learn.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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 for create or update operations.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Courses Delete Course

`<blackboard:courses-delete-course>`

Deletes a course.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>courseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course ID.</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>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Courses Get Course

`<blackboard:courses-get-course>`

Returns details for a single course.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>courseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Courses Get Course Child

`<blackboard:courses-get-course-child>`

Returns one child course record for a parent course.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>courseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>childCourseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Child course ID in a course merge hierarchy.</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>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Courses Get Course Children

`<blackboard:courses-get-course-children>`

Returns child courses associated with a parent course.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>courseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>includePermissions</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to include permission metadata in the response.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>expand</p></td><td><div><div><p>String</p></div></div></td><td><p>Related resources to expand in the response.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>Zero-based index of the first item to return.</p></td><td></td><td></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of items to return.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Courses Get Courses

`<blackboard:courses-get-courses>`

Searches or lists courses using query parameters supported by the 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>Zero-based index of the first item to return.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of items to return.</p></td><td></td><td></td></tr><tr><td><p>includePermissions</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to include permission metadata in the response.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>modified</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter by last modified timestamp.</p></td><td></td><td></td></tr><tr><td><p>modifiedCompare</p></td><td><div><div><p>String</p></div></div></td><td><p>Comparison operator for the modified filter.</p></td><td></td><td></td></tr><tr><td><p>courseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course ID.</p></td><td></td><td></td></tr><tr><td><p>name</p></td><td><div><div><p>String</p></div></div></td><td><p>Name of the resource.</p></td><td></td><td></td></tr><tr><td><p>description</p></td><td><div><div><p>String</p></div></div></td><td><p>Description of the resource.</p></td><td></td><td></td></tr><tr><td><p>externalId</p></td><td><div><div><p>String</p></div></div></td><td><p>External identifier for the resource.</p></td><td></td><td></td></tr><tr><td><p>created</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter by resource creation timestamp.</p></td><td></td><td></td></tr><tr><td><p>createdCompare</p></td><td><div><div><p>String</p></div></div></td><td><p>Comparison operator for the created timestamp filter.</p></td><td></td><td></td></tr><tr><td><p>allowGuests</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether guests are allowed.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>availability.available</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter by availability status.</p></td><td></td><td></td></tr><tr><td><p>dataSourceId</p></td><td><div><div><p>String</p></div></div></td><td><p>Data source ID.</p></td><td></td><td></td></tr><tr><td><p>termId</p></td><td><div><div><p>String</p></div></div></td><td><p>Academic term ID.</p></td><td></td><td></td></tr><tr><td><p>organization</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to apply organization scope to the request.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>sort</p></td><td><div><div><p>String</p></div></div></td><td><p>Sort order for the result set.</p></td><td></td><td></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Courses Remove Child Course

`<blackboard:courses-remove-child-course>`

Removes the child relationship between a child course and its parent course.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>courseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>childCourseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Child course ID in a course merge hierarchy.</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>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Courses Update Course

`<blackboard:courses-update-course>`

Updates properties of an existing course.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>courseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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 for create or update operations.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Roles Get Course Role

`<blackboard:roles-get-course-role>`

Returns a single course role definition by ID.

### 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>The name of the configuration to use.</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 ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Roles Get Course Roles

`<blackboard:roles-get-course-roles>`

Returns course roles available in the system.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>Zero-based index of the first item to return.</p></td><td></td><td></td></tr><tr><td><p>includePermissions</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to include permission metadata in the response.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of items to return.</p></td><td></td><td></td></tr><tr><td><p>sort</p></td><td><div><div><p>String</p></div></div></td><td><p>Sort order for the result set.</p></td><td></td><td></td></tr><tr><td><p>custom</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether the resource is user-defined or custom.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>roleId</p></td><td><div><div><p>String</p></div></div></td><td><p>Role ID.</p></td><td></td><td></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Roles Get Institution Role

`<blackboard:roles-get-institution-role>`

Returns a single institution role definition by ID.

### 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>The name of the configuration to use.</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 ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Roles Get Institution Roles

`<blackboard:roles-get-institution-roles>`

Returns institution roles defined in the system.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>Zero-based index of the first item to return.</p></td><td></td><td></td></tr><tr><td><p>includePermissions</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to include permission metadata in the response.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of items to return.</p></td><td></td><td></td></tr><tr><td><p>sort</p></td><td><div><div><p>String</p></div></div></td><td><p>Sort order for the result set.</p></td><td></td><td></td></tr><tr><td><p>custom</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether the resource is user-defined or custom.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>roleId</p></td><td><div><div><p>String</p></div></div></td><td><p>Role ID.</p></td><td></td><td></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Terms Create Term

`<blackboard:terms-create-term>`

Creates an academic term.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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 for create or update operations.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Terms Delete Term

`<blackboard:terms-delete-term>`

Deletes a term.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>termId</p></td><td><div><div><p>String</p></div></div></td><td><p>Academic term ID.</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>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Terms Get Term

`<blackboard:terms-get-term>`

Returns details for a single term.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>termId</p></td><td><div><div><p>String</p></div></div></td><td><p>Academic term ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Terms Get Terms

`<blackboard:terms-get-terms>`

Returns terms, optionally filtered by query parameters.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>Zero-based index of the first item to return.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of items to return.</p></td><td></td><td></td></tr><tr><td><p>includePermissions</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to include permission metadata in the response.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>externalId</p></td><td><div><div><p>String</p></div></div></td><td><p>External identifier for the resource.</p></td><td></td><td></td></tr><tr><td><p>dataSourceId</p></td><td><div><div><p>String</p></div></div></td><td><p>Data source ID.</p></td><td></td><td></td></tr><tr><td><p>availability.available</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter by availability status.</p></td><td></td><td></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Terms Update Term

`<blackboard:terms-update-term>`

Updates an existing term.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>termId</p></td><td><div><div><p>String</p></div></div></td><td><p>Academic term ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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 for create or update operations.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Token Access Token

`<blackboard:token-access-token>`

Requests an access token from the Blackboard Learn authorization server using the configured
credentials.

### 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>The name of the configuration to use.</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>Optional client-supplied identifier for correlating requests.</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 for create or update operations.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Users Create User

`<blackboard:users-create-user>`

Creates a user in Blackboard Learn.

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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 for create or update operations.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Users Delete User

`<blackboard:users-delete-user>`

Deletes 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>The name of the configuration to use.</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 ID.</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>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Users Get User

`<blackboard:users-get-user>`

Returns details for a single 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>The name of the configuration to use.</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 ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Users Get Users

`<blackboard:users-get-users>`

Searches or lists users using query parameters supported by the 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>Zero-based index of the first item to return.</p></td><td></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of items to return.</p></td><td></td><td></td></tr><tr><td><p>includePermissions</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to include permission metadata in the response.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>userName</p></td><td><div><div><p>String</p></div></div></td><td><p>Username filter or value.</p></td><td></td><td></td></tr><tr><td><p>externalId</p></td><td><div><div><p>String</p></div></div></td><td><p>External identifier for the resource.</p></td><td></td><td></td></tr><tr><td><p>created</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter by resource creation timestamp.</p></td><td></td><td></td></tr><tr><td><p>createdCompare</p></td><td><div><div><p>String</p></div></div></td><td><p>Comparison operator for the created timestamp filter.</p></td><td></td><td></td></tr><tr><td><p>modified</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter by last modified timestamp.</p></td><td></td><td></td></tr><tr><td><p>modifiedCompare</p></td><td><div><div><p>String</p></div></div></td><td><p>Comparison operator for the modified filter.</p></td><td></td><td></td></tr><tr><td><p>lastLogin</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter by last login timestamp.</p></td><td></td><td></td></tr><tr><td><p>lastLoginCompare</p></td><td><div><div><p>String</p></div></div></td><td><p>Comparison operator for the lastLogin filter.</p></td><td></td><td></td></tr><tr><td><p>dataSourceId</p></td><td><div><div><p>String</p></div></div></td><td><p>Data source ID.</p></td><td></td><td></td></tr><tr><td><p>institutionRoleIds</p></td><td><div><div><p>Array of String</p></div></div></td><td><p>Institution role IDs to filter by.</p></td><td></td><td></td></tr><tr><td><p>name.family</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter by family name.</p></td><td></td><td></td></tr><tr><td><p>studentId</p></td><td><div><div><p>String</p></div></div></td><td><p>Student user ID.</p></td><td></td><td></td></tr><tr><td><p>contact.email</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter by contact email address.</p></td><td></td><td></td></tr><tr><td><p>availability.available</p></td><td><div><div><p>String</p></div></div></td><td><p>Filter by availability status.</p></td><td></td><td></td></tr><tr><td><p>sort</p></td><td><div><div><p>String</p></div></div></td><td><p>Sort order for the result set.</p></td><td></td><td></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Users Update User

`<blackboard:users-update-user>`

Updates an existing 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>The name of the configuration to use.</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 ID.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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 for create or update operations.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Users Upcoming Events

`<blackboard:usersupcoming-events>`

Returns upcoming events for the authenticated user (for example, calendar or course activity within
the requested range).

### 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>The name of the configuration to use.</p></td><td></td><td><p>x</p></td></tr><tr><td><p>courseId</p></td><td><div><div><p>String</p></div></div></td><td><p>Course ID.</p></td><td></td><td></td></tr><tr><td><p>type</p></td><td><div><div><p>String</p></div></div></td><td><p>Event or entity type filter.</p></td><td></td><td></td></tr><tr><td><p>since</p></td><td><div><div><p>String</p></div></div></td><td><p>Lower bound (inclusive) for the time range filter.</p></td><td></td><td></td></tr><tr><td><p>until</p></td><td><div><div><p>String</p></div></div></td><td><p>Upper bound (inclusive) for the time range filter.</p></td><td></td><td></td></tr><tr><td><p>offset</p></td><td><div><div><p>Number</p></div></div></td><td><p>Zero-based index of the first item to return.</p></td><td></td><td></td></tr><tr><td><p>includePermissions</p></td><td><div><div><p>Boolean</p></div></div></td><td><p>Whether to include permission metadata in the response.</p></td><td><p>false</p></td><td></td></tr><tr><td><p>limit</p></td><td><div><div><p>Number</p></div></div></td><td><p>Maximum number of items to return.</p></td><td></td><td></td></tr><tr><td><p>sort</p></td><td><div><div><p>String</p></div></div></td><td><p>Sort order for the result set.</p></td><td></td><td></td></tr><tr><td><p>fields</p></td><td><div><div><p>String</p></div></div></td><td><p>Comma-separated list of fields to include in the response.</p></td><td></td><td></td></tr><tr><td><p>correlationId</p></td><td><div><div><p>String</p></div></div></td><td><p>Optional client-supplied identifier for correlating requests.</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>The 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 that stores the operation’s output.</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

- BLACKBOARD:BAD\_REQUEST

- BLACKBOARD:CLIENT\_ERROR

- BLACKBOARD:CONFLICT

- BLACKBOARD:CONNECTIVITY

- BLACKBOARD:FORBIDDEN

- BLACKBOARD:INTERNAL\_SERVER\_ERROR

- BLACKBOARD:NOT\_FOUND

- BLACKBOARD:SECURITY

- BLACKBOARD:SERVER\_ERROR

- BLACKBOARD:TIMEOUT

- BLACKBOARD:UNAUTHORIZED

## Types

### 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>Enabled Protocols</strong></p></td><td><div><div><p>String</p></div></div></td><td><div><div><p>A 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>A 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">Trust Store</a></p></div></div></td><td><div><div><p>Trust store configuration for TLS.</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">Key Store</a></p></div></div></td><td><div><div><p>Key store configuration for TLS.</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>Certificate revocation checking configuration.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Trust Store

<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>The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store.</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>The password used to protect the trust store.</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>The type of store used.</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>The algorithm used by the trust store.</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 true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Key Store

<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>The location (which will be resolved relative to the current classpath and file system, if possible) of the key store.</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>The type of store used.</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>When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default.</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>The 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>The password used to protect the key 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>The algorithm used by the key store.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Standard Revocation Check

<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>Only verifies the last element of 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>Try CRL instead of OCSP first.</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>Do not use the secondary checking method (the one not selected before).</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>Avoid verification failure when the revocation server can not be reached or is busy.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Custom OCSP Responder

<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>The 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 (must be in the trust store), if present.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### 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>The path to the CRL file.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnection

<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>The reconnection strategy to use.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect

<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 in milliseconds to reconnect.</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 false, 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 to make.</p></div></div></td><td><div></div></td><td><div></div></td></tr></tbody></table>

### Reconnect Forever

<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 in milliseconds to reconnect.</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 false, 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

<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>A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered 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>Mule error type that triggers this mapping.</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>Name of the 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>