Configure Connection
OneRoster v1.1 guide
Arrange API access with your application vendor, configure the OneRoster v1.1 connection in NIM, and validate source data for provisioning and rostering.
Before you beginDirect link to Before you begin
OneRoster is a data exchange standard implemented by multiple applications. Contact your application vendor to determine how its OneRoster v1.1 API can be configured and which data it exposes.
NIM requires Hostname, Token URI, Client ID, and Client Secret.
Obtain API credentials and endpointsDirect link to Obtain API credentials and endpoints
- Ask your vendor to configure OneRoster v1.1 API access for NIM in the intended environment.
- Obtain the Hostname, authentication Token URI, Client ID, and Client Secret.
- Confirm read access to organizations and the user, class, enrollment, and other roster data required by your downstream process.
- Store the client secret securely. Use the vendor-specific references below where applicable.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add a OneRoster v1.1 system, or select the existing system.
- Open Connection, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Hostname | The host supplied for your application's OneRoster API, using the format expected by the Connection screen. |
| Token URI | The authentication token endpoint supplied by your vendor. |
| Client ID | The client identifier supplied for API access. |
| Client Secret | The secret associated with that client. |
Test organization retrievalDirect link to Test organization retrieval
-
Select Test Connection. NIM calls the following path to retrieve organizations:
GET /ims/oneroster/v1p1/orgs -
If the test fails, verify the Hostname, Token URI, client credentials, network access, and organization read permissions with your vendor.
-
Collect the users and roster collections needed by your process, and confirm that the expected records are present.
-
Validate identity matching, field mappings, and roster relationships before using the data for downstream provisioning or rostering.
The connection test checks organization retrieval. Validate the other collections required by your process separately.
Blackbaud SISDirect link to Blackbaud SIS
Configure the OneRoster connection using the vendor's Blackbaud OAuth documentation.
Infinite Campus SISDirect link to Infinite Campus SIS
Review the OneRoster v1.1 data models before configuring your connection. They describe the records and relationships that Infinite Campus exposes through OneRoster.
Then follow Infinite Campus's OneRoster connection configuration documentation.
Skyward QmlativDirect link to Skyward Qmlativ
For Skyward Qmlativ, use the dedicated Skyward Qmlativ integration guide.