For data security, encryption, and credential storage information that applies across all connectors, see Data & Security - Enterprise Search Connectors.
The connector never writes to or modifies data in Gainsight.
Credentials are stored encrypted and are never exposed in logs, search results, or the Simpplr UI after initial entry.
Auth type: OAuth 2.0 machine-to-machine (client credentials).
The Gainsight API connection you create must provide the following:
Permission / capability | Why it's needed |
|---|---|
Instance domain | Identifies your Gainsight tenant, for example |
OAuth client ID (OAuth API Key) | Identifies the connection that Simpplr uses to request access tokens |
OAuth client secret (OAuth API Secret) | Proves the connection's identity when Simpplr requests an access token |
Read access to Company, Relationship, Timeline, Cockpit (CTAs and tasks), and Success Plans | Reads the records that are indexed for search, and reads deletions so removed records leave the index |
Read access to Gainsight users | Reads active internal users and their email addresses, so Simpplr knows who may see Gainsight results |
Only a Gainsight Super Admin in an active state can create, manage, or revoke this connection. If you are not a Super Admin, coordinate with one before proceeding to setup.
Why it's required: Gainsight's OAuth connection screen (Administration → Connectors 2.0) has no scope selector and no way to attach a permission bundle or a user. Every OAuth credential Gainsight issues carries full API access. This is a Gainsight product limitation.
What the connector actually does with it: Reads Company, Relationship, Timeline Activity, CTA, Task, and Success Plan records, reads which of those records were deleted, and lists users. It never creates, updates, or deletes anything.
If not granted: The connector cannot authenticate and no Gainsight content is indexed.
Gainsight allows only one Access Key per organisation, shared by every integration. Rotating it breaks all of them at once. Gainsight allows up to 15 OAuth connections, so Simpplr gets its own credential that you can revoke without affecting anything else.
Gainsight does not offer a narrower permission model for the APIs this connector uses.
Supported: Gainsight CS (NXT) cloud, including regional instances (for example .us2) and vanity domains
Not supported: Gainsight PX, Gainsight Customer Communities
Gainsight does not expose per-record permissions through its API. Record visibility inside Gainsight is controlled by permission bundles and data-sharing rules that the API cannot read. The connector therefore applies one permission to all indexed Gainsight content, and Simpplr enforces it at query time.
Who can see Gainsight results: Simpplr users whose email address matches an active, internal Gainsight user. They can see every indexed company, relationship, timeline activity, CTA, task, and success plan, including records they could not open inside Gainsight.
Who cannot: Deactivated Gainsight users, external or customer contacts that exist as Gainsight users, Gainsight users with no email address, and Simpplr users with no matching Gainsight user. They get no Gainsight results and no Gainsight autocomplete suggestions.
User and group sync: Active internal Gainsight users are synced to Simpplr by the permission sync, which runs daily. Gainsight groups and roles are not used, because the API does not expose them.
Item permission changes: Not applicable. Changes to permission bundles or sharing inside Gainsight do not change who can find a record in Simpplr.
Access removal: When a Gainsight user is deactivated or becomes external, they stop seeing Gainsight results after the next permission sync, so within about a day. When a record is deleted in Gainsight, see Content, Sync & Limitations - Gainsight for how quickly it leaves search.