Configure Connection
ModernCampus Lumens guide
Arrange API access, enter the Lumens hostname and API key in NIM, and collect data to validate the connection.
Before you beginDirect link to Before you begin
API setup information is protected by login. Sign in to the vendor's Lumens Web Services documentation and follow the requirements for your environment. Contact your Lumens administrator or vendor support if you need documentation access or setup assistance.
NIM requires Hostname and API Key.
Verify the connection with a collection
Test Connection always returns successful for this connector. It does not validate credentials or API access. Run a collection to test the connection.
Obtain API credentialsDirect link to Obtain API credentials
- Sign in to the protected Web Services documentation and complete the vendor's API setup requirements.
- Obtain the Hostname and API Key for the environment NIM will access.
- Confirm access to the source data needed for your downstream user lifecycle process and store the key securely.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add a ModernCampus Lumens system, or select the existing system.
- Open Connection, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Hostname | The Lumens host for the intended environment, using the format expected by the Connection screen. |
| API Key | The API key supplied for access to that environment. |
Verify access by collecting dataDirect link to Verify access by collecting data
- Run a collection from the ModernCampus Lumens system in NIM. A successful Test Connection result alone does not verify access.
- Confirm that the collection completes and that the expected source records are present.
- If collection fails, review the error and verify the Hostname, API Key, network access, and API permissions with your administrator or vendor support.
- Validate identity matching and field mappings before using the collected data for downstream user lifecycle provisioning.
Step 1 of 3