Configure Connection
D2L Brightspace guide
Register an OAuth application in Brightspace, authorize NIM with the intended API service account, and test the account identity.
Before you beginDirect link to Before you begin
Follow D2L's OAuth 2.0 setup documentation alongside the existing NIM procedure below. You need a Brightspace administrator to register the application and an API service account with the permissions required by your process.
Have the Customer Name, Username, and Password available for your environment and service account. The public NIM connector uses OAuth: it also needs the application's Client ID and Client Secret. The service account credentials are used when signing in to authorize access through Retrieve Token.
Configure the Brightspace applicationDirect link to Configure the Brightspace application
- Sign in to the Brightspace portal as an administrator.
- Go to Settings > Manage Extensibility > OAuth 2.0.
- Select Register an App and configure the following values.
| Setting | Value |
|---|---|
| Name | Tools4ever NIM |
| Redirect URI | Copy the Redirect URI from the NIM system's Connection screen. |
| Scope | attributes:*:* core:*:* role:*:* sessions:*:* users:*:* |
| Access Token Lifetime (seconds) | 72000, as used in the existing NIM setup. |
| Prompt for user consent | Unchecked, as used in the existing NIM setup. |
| Enable refresh tokens | Checked. |
- Save the application and securely record its Client ID and Client Secret.
The scope list above preserves the existing connector setup. Confirm that the authorizing account has the permissions needed to read and create users and maintain user attributes.
Enter settings and retrieve a tokenDirect link to Enter settings and retrieve a token
- In NIM Studio, open Systems > Overview and add a D2L Brightspace system, or select the existing system.
- Open Connection and configure the environment and OAuth application.
| Value | How it is used |
|---|---|
| Customer Name / tenant host | The Brightspace hostname for your environment. The public connector constructs https://{tenant_id}, so supply the hostname without an additional https:// prefix. |
| Client ID | The ID generated by the Brightspace OAuth application registration. |
| Client Secret | The secret generated for that application. |
| Username and Password | The API service account's credentials for the Brightspace sign-in during authorization. |
- Save the settings and select Retrieve Token.
- Complete the Brightspace authorization flow as the intended API service account. If the browser is already signed in as another user, switch to the intended account before completing authorization.
- Complete the return to NIM and save the connection as required by the Connection screen.
Test the API service accountDirect link to Test the API service account
-
Select Test Connection. NIM attempts to retrieve the authenticated API service account using:
GET /d2l/api/lp/1.9/users/whoami -
Confirm that the returned identity is the intended service account.
-
If the test fails, check the tenant hostname, Client ID, Client Secret, Redirect URI, token authorization, and account permissions.
-
Collect users and the attribute schema, then validate user matching and attribute mappings.
-
Test user creation and intended attribute changes with safe records before enabling automation.
The connection test checks the authenticated identity. Validate user creation and attribute permissions separately. The connector lists user attributes as Read, Create, and Delete operations; use its supported attribute actions to maintain values.