Configure Connection
SAP Litmos guide
Arrange API access with Litmos, configure the tenant URL and token in NIM, and test access by retrieving one user.
Before you startDirect link to Before you start
Instructions for creating API access are not publicly available. Contact Litmos to request API access and setup documentation for your tenant. See the Litmos integrations overview for the vendor's integration information.
NIM requires Tenant URL and Token.
Obtain the tenant URL and tokenDirect link to Obtain the tenant URL and token
- Contact Litmos to arrange API access and obtain the setup documentation for your environment.
- Obtain the Tenant URL and API Token for the integration.
- Confirm that the token permits user and team data collection and the provisioning operations your process needs.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add an SAP Litmos system, or select the existing system.
- Open its Connection screen.
- Enter the following settings and save the connection.
| NIM setting | Value |
|---|---|
| Tenant URL | The Litmos API tenant URL provided for your integration. |
| Token | The API token issued for access to that tenant. |
Test user accessDirect link to Test user access
-
Select Test Connection. NIM calls this endpoint on the configured tenant:
GET /v1.svc/users/paginated?limit=1&start=0The request starts at the first record and retrieves at most one user.
-
Confirm that the test succeeds. If it fails, verify the Tenant URL, Token, and API access with Litmos.
-
Collect the system and inspect users, teams, and teams_users to confirm that the expected records are available.
-
Validate intended user lifecycle changes, team creation, and user assignments with safe test records before enabling scheduled automation.
The connection test reads user data. Validate team collection and each intended provisioning operation separately.