Configure Connection
SCIM 2.0 guide
Arrange SCIM access in your target product, configure the NIM connection, and validate supported user and group operations.
Before you beginDirect link to Before you begin
SCIM is an open standard for exchanging and managing user and group information. Multiple products implement it, so API setup and available operations vary. Follow the documentation for your specific product and version to enable SCIM 2.0 and configure API access. See the SCIM standard reference for background.
NIM requires Tenant URL and API Key.
Obtain the SCIM endpoint and credentialsDirect link to Obtain the SCIM endpoint and credentials
- Use the product's documentation or vendor support to enable its SCIM 2.0 API for the intended environment.
- Obtain the Tenant URL for the SCIM service and the API Key required by the NIM connector.
- Confirm support and permissions for the user, group, and membership operations your process needs. Verify the product's schema and required attributes.
- Store the API key securely.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add a SCIM 2.0 system, or select the existing system.
- Open Connection, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Tenant URL | The product's SCIM API base address, including any required base path and using the format expected by the Connection screen. |
| API Key | The credential authorized for access to that SCIM service. |
Test service configuration retrievalDirect link to Test service configuration retrieval
-
Select Test Connection. NIM attempts to retrieve the service configuration using the following path relative to the configured SCIM base address:
GET /ServiceProviderConfig -
If the test fails, verify the Tenant URL, API Key, network access, and the product's SCIM configuration and permissions.
-
Collect service configuration, schemas, resource types, users, groups, and memberships as required by your process and supported by the product.
-
Validate identity matching, attribute mappings, and group relationships. Test intended user lifecycle and membership operations with safe records before enabling automation.
The connection test checks service configuration retrieval. It does not confirm that the product supports every operation listed for the NIM connector. Validate each required collection and write operation against the product's implementation.