Configure Connection
Instructure Canvas guide
Arrange Canvas API access, enter the hostname and API token in NIM, and validate account retrieval before enabling provisioning.
Before you beginDirect link to Before you begin
Review Instructure's developer API key setup instructions with your Canvas administrator. Developer API keys configure OAuth applications that obtain access tokens on a user's behalf.
NIM requires Hostname and API Key. The public NIM connector sends the API Key value as a bearer access token. Supply an authorized access token, rather than a developer key's client ID or client secret.
Obtain an access tokenDirect link to Obtain an access token
- Work with your Canvas administrator to choose the account and token method approved for NIM.
- If your institution uses an OAuth integration, follow the linked developer key instructions and its authorization process to obtain an access token.
- If your institution permits a manually generated token, follow Instructure's user API access token instructions.
- Confirm that the token's account permissions and any applicable scopes cover the accounts, users, logins, courses, and enrollment operations required by your process.
- Store the token securely and plan for its expiration or replacement. See Instructure's access token usage guidance for how tokens are used for API access.
The public connector accepts an existing bearer token; it does not configure the OAuth authorization flow for you.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add an Instructure Canvas system, or select the existing system.
- Open Connection, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Hostname | Your Canvas host, such as school.instructure.com. The public connector adds https:// and /api; do not duplicate them in this field. |
| API Key | The authorized Canvas access token. Enter the token itself; the connector adds the Bearer header prefix. |
Test account retrievalDirect link to Test account retrieval
-
Select Test Connection. NIM attempts to retrieve accounts using the following path relative to its API base URL:
GET /v1/accounts -
If the test fails, verify the Hostname, token validity, network access, and permission to retrieve accounts.
-
Collect the users, logins, courses, sections, terms, and enrollments required by your process.
-
Validate user matching, login mappings, and course relationships. Test intended user, login, and enrollment changes with safe records before enabling automation.
The connection test checks account retrieval. Validate each intended provisioning operation separately. The connector reads courses, sections, and terms, and supports enrollment creation and deletion for course participation management.