Okta Gainsight SCIM Setup
This article explains how to configure SCIM (System for Cross-domain Identity Management) integration between Okta and Gainsight. SCIM enables automated user provisioning and de-provisioning.
Overview
SCIM integration automates the provisioning lifecycle of users in Gainsight by connecting with your identity provider, Okta. Once configured, the SCIM integration allows you to:
- Automatically create, update, and deactivate users in Gainsight based on Okta assignments.
- Synchronize user profile attributes and custom fields between systems.
- Improve security and efficiency by managing access centrally through Okta.
This guide outlines the full setup process in Okta, including SAML configuration, SCIM connector settings, OAuth authentication, and optional custom field mappings.
Prerequisite
To complete the setup process, admins must have
- Access to both Okta and Gainsight.
- Ensure SAML-based SSO is already configured in Okta for Gainsight. For more information, refer to the Gainsight Authentication article.
Create SCIM Application in Okta
- Log in to your Okta Admin Console.
- Click Create Application.
- Select SAML 2.0, click Next.
- Under General Settings, enter app name Gainsight SCIM Integration.
- Click Next.
- Configure the following using metadata.xml from Gainsight:
- Single Sign-On URL
- Audience URI (SP Entity ID)
For more information, refer to the Gainsight Authentication article.
- Click Next > Finish.
Enable SCIM Provisioning
After the app is created, you can enable the SCIM provisioning:
- Navigate to General tab.
- Click Edit. The App Settings dialog appears.
- Under the Provisioning option, select SCIM.
- Click Save. The Proviosing tab is now enabled
- Configure the below details in the Provisioning tab.
Field |
Value |
---|---|
SCIM Connector Base URL |
https://<your-gainsight-tenant-url>/v1/users/services/scim |
Unique Identifier Field for Users |
userName |
Supported Provisioning Actions |
|
Authentication Mode: OAuth 2.0 |
For more information on OAuth, refer to the OAuth for Gainsight APIs |
Access Token Endpoint URI |
https://<your-gainsight-tenant-url>/v1/users/oauth/access/token |
Authorization Endpoint URI |
https://<your-gainsight-tenant-url>/v1/authorize?clientId=<<clinetId_from_Gainsight_OAuth>>&redirectUri=https://system-admin.okta.com/admin/app/cpc/<<please_enter_okta_application_name>>/oauth/callback&scopes=read_write |
- Click the Authenticate with Gainsight SCIM Integration and authorize Gainsight.
Add Custom Field Mappings
Gainsight supports custom fields in SCIM APIs with the following data types:
- Boolean
- String
- Picklist
- Multi-Picklist
Gainsight recommends to contact Gainsight Support to add the same mappings on the Gainsight instance. This ensures that the fields are included in the User Create and Update APIs.
To configure these fields in Okta:
- Navigate to Directory > Profile Editor.
- Select your SCIM integration app.
- Click +Add Attribute.
Note: The Gainsight SCIM external namespace is urn:ietf:params:scim:schemas:extension:gainsight:2.0:User
Below images show few examples of data types supported in SCIM API: