Configure Connection
OneRoster v1.2 guide
Arrange API access with your application vendor, configure the OneRoster v1.2 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.2 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.2 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. Confirm that the vendor's API version and supported scopes match the installed connector.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add a OneRoster v1.2 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. The public connector adds https://; enter the hostname without duplicating that prefix. |
| Token URI | The authentication token endpoint supplied by your vendor. The public connector adds https:// here too, so enter the host and token path without that prefix. |
| 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. The public OneRoster v1.2 connector calls the following path to retrieve organizations:
GET /ims/oneroster/rostering/v1p2/orgs -
If the test fails, verify the Hostname, Token URI, client credentials, network access, API version, and organization read permissions with your vendor.
-
Collect the users and roster collections required by your process. Review collection filters if expected records are missing.
-
Validate identity matching, field mappings, and roster relationships before using the data for downstream provisioning or rostering.
The /ims/oneroster/v1p1/orgs path is the v1.1 endpoint. Use the path configured by your installed connector and confirm v1.2 support with the vendor. The connection test checks organization retrieval; validate other required collections separately.
Blackbaud SISDirect link to Blackbaud SIS
Configure the OneRoster connection using the vendor's Blackbaud OAuth documentation.
Confirm that the configured connection supports OneRoster v1.2 before using this connector.
Infinite Campus SISDirect link to Infinite Campus SIS
The existing OneRoster v1.1 data models reference describes Infinite Campus records and relationships for v1.1. Ask Infinite Campus for the applicable v1.2 requirements before using this connector.
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.