> For the complete documentation index, see [llms.txt](https://docs.appmixer.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.appmixer.com/connector-configuration/blackboard.md).

# Blackboard

## OAuth app properties

| Property                | Value                                                                                                                                                                                                                           |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Multi-tenant**        | **Conditional.** One app serves any Blackboard Learn site whose administrator registers its Application ID under **REST API Integrations**, up to the site quota of your developer group (6 sites by default).                  |
| **Vendor review**       | **None.** Each institution's Learn administrator decides whether to register the app. More sites or API calls need a production group increase from Anthology, for clients and partners through a Behind the Blackboard ticket. |
| **Review time**         | Not applicable.                                                                                                                                                                                                                 |
| **Users before review** | No user limit. At most 6 Learn sites by default.                                                                                                                                                                                |
| **App owner**           | An account on the Anthology developer portal ([developer.blackboard.com](https://developer.blackboard.com)).                                                                                                                    |
| **Regions**             | One app works with Learn sites anywhere.                                                                                                                                                                                        |
| **Client secret**       | No expiry documented. It is shown only once; if you lose it, create a new key.                                                                                                                                                  |
| **Rate limits**         | 10,000 calls per 24 hours by default for the developer group. The connector throttles itself to the same number.                                                                                                                |
| **Checked**             | 2026-11-13                                                                                                                                                                                                                      |

**Limitations**

* The connector configuration holds one `serverUrl`, so one Appmixer configuration connects to one Learn site.
* The connector requests only the `read` scope. Blackboard returns a refresh token only for the `offline` scope, so when the access token expires, the user has to connect the account again.
* With only the `read` scope, Blackboard can refuse write calls such as **Create Assignment**.
* When your developer group reaches its site quota, the next institution that registers the app gets the error "Application developer has exceeded maximum number of client installations".

Sources: [Production groups, REST API and site registration limits](https://docs.blackboard.com/docs/developer-portal/production-groups-rest-api-and-site-registration-limits), [Three-legged OAuth](https://docs.blackboard.com/docs/blackboard/rest-apis/getting-started/3lo). What the rows mean: [OAuth app properties](https://docs.appmixer.com/connector-configuration/oauth-app-properties.md).

## Create Blackboard App in the Developer portal

The first thing you need is an app created in the developer portal. Navigate to [https://developer.blackboard.com ](https://developer.blackboard.com/)and signup for an account. When you are logged in, you can see a dashboard with a list of your applications and a button to create a new one:

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-702df879fbc557c6774f0692dc1401d3dfd18adb%2Fblackboard-1.png?alt=media" alt=""><figcaption></figcaption></figure>

Note that listed applications have an Application ID. We will need it when we register our application in the blackboard instance. Click on the + button to create a new application. A simple form appears with your Application name and description inputs, and a *domains* input, for your domains. After you fill in the fields, create the new application.

## Register your application on Blackboard

### Self-managed instances

Log in with admin privileges, and go to the System Admin tab in the top menu. After that, look under Integrations for REST API Integrations:

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-cd6415178371ec8fb3f966738a7f852befda3563%2Fblackboard-2.png?alt=media" alt=""><figcaption><p>REST API Integrations option</p></figcaption></figure>

Next, you will see a list with all your API Integrations. Click on Create Integration to add a new one:

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-e18526a0880b91242c09c0731ead92614843d0d2%2Fblackboard-3.png?alt=media" alt=""><figcaption><p>REST API Integrations list</p></figcaption></figure>

After that, you will show a small form. One of the inputs is the Application ID which as we showed in the first step, is available in the applications list at the developer portal. Next, browse and select a user. We recommend using the same user you are logged in with. On the *End User Access* and *Authorized To Act As User*, select Yes in both options. After that click on Submit to finish the registration.

## Create an application key

The connector needs the OAuth client ID and secret of your application. To obtain these values, go to the applications list in the developer portal. Find your application and click on the 3 dots at the end of the row. Then click on the Manage Keys option:

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-b4fb5455de84164cc52139e7a764026b378ab8d2%2Fblackboard-4.png?alt=media" alt=""><figcaption><p>Manage Keys in developer portal</p></figcaption></figure>

After you will see a list of your application keys. Click on the + sign to create a new key. Your key will be created and its information will be shown to you:

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-154994a4ab9f972bbf8b6222bc0850b10a7e4dfe%2Fblackboard-5.png?alt=media" alt=""><figcaption><p>Key information</p></figcaption></figure>

Be sure to store this information somewhere safe, as you won't be able to get it again.

## Backoffice configuration

Configuration ID: `appmixer:blackboard` (Backoffice → Configuration; see [Connector Configuration](https://docs.appmixer.com/getting-started/services) for how a configuration is created and how its keys reach the connector).

* `clientId` — The **Application ID** of your application in the developer portal.
* `clientSecret` — The **Secret** of the key created above.
* `serverUrl` — URL of your Blackboard Learn instance, without a trailing slash, for example `https://blackboard.example.edu`. All API calls, sign-in and token requests go to this URL, so one configuration connects to one Learn site.

<figure><img src="https://802996127-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FIAGKHlIqVKJe9agnFr14%2Fuploads%2Fgit-blob-1570c234bc859734d6c691a4747ee93345d4fe4e%2Fblackboard-6.png?alt=media" alt=""><figcaption><p>Blackboard configuration</p></figcaption></figure>

The same keys can be set with the CLI (`-u` updates the existing configuration instead of creating it):

```bash
appmixer service-config set appmixer:blackboard -u -d '{
  "clientId": "<application id>",
  "clientSecret": "<secret>",
  "serverUrl": "<learn instance url>"
}'
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.appmixer.com/connector-configuration/blackboard.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
