Configure Connection

NEOGOV Connect guide

Create a service account for API access, configure its credentials in NIM, and test employee collection.

Before you startDirect link to Before you start

API access uses a service account created for the integration. See the NEOGOV API authentication documentation for the vendor's authentication requirements.

NIM requires the service account's Username and Password.

Prepare API accessDirect link to Prepare API access

Create a dedicated NEOGOV service account that can be used for API access, following the vendor documentation linked above.
Give the account access to the employee and organizational data your NIM process needs.
Record the service account's username and password for the NIM connection.

Enter the connection settingsDirect link to Enter the connection settings

In NIM Studio, open Systems > Overview and add a NEOGOV Connect system, or select the existing system.
Open its Connection screen.
Enter the following settings and save the connection.

NIM setting	Value
Username	The username of the service account enabled for NEOGOV API access.
Password	The password belonging to that service account.

Test employee accessDirect link to Test employee access

Select Test Connection. NIM calls the employee endpoint:
```
GET /rest/employees
```
This request collects employee data to test the connection.
Confirm that the test succeeds. If it fails, verify the service account's username, password, account status, and API access.
Collect the system and inspect the employees data, along with any organizational collections your process uses, such as departments, divisions, and positions.
Validate the returned records and matching rules before using the data for reporting or provisioning accounts in downstream systems.

The connection test checks employee access. Validate other collections and the intended provisioning operations in each destination system separately.

Step 1 of 3