Generated by API Evangelist
Written by API Evangelist tooling for Gainsight's API. It is a proposal applied on top of the contract, not a document Gainsight publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Gainsight CS User Management SCIM API
version: 1.0.0
extends: openapi/gainsight-scim-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 5
- target: $.paths['/scim/v2/Users'].get
update:
x-apievangelist-phrasing:
intent: List users via SCIM
effect: read
questions:
- How does my identity provider list Gainsight users over SCIM?
- Can I filter SCIM users by userName?
instructions:
- text: List SCIM users matching {filter}.
slots:
filter: query.filter
- text: Get {count} SCIM users starting at index {startIndex}.
slots:
count: query.count
startIndex: query.startIndex
method: generated
generated: '2026-09-26'
- target: $.paths['/scim/v2/Users'].post
update:
x-apievangelist-phrasing:
intent: Provision a user via SCIM
effect: write
questions:
- How do I provision a new Gainsight user from my identity provider?
- What fields does SCIM user creation require?
instructions:
- text: Provision SCIM user {userName} named {name} with emails {emails} and schemas {schemas}.
slots:
userName: requestBody.userName
name: requestBody.name
emails: requestBody.emails
schemas: requestBody.schemas
- text: Create an active ({active}) SCIM user {userName}, name {name}, emails {emails}, schemas {schemas}.
slots:
active: requestBody.active
userName: requestBody.userName
name: requestBody.name
emails: requestBody.emails
schemas: requestBody.schemas
method: generated
generated: '2026-09-26'
- target: $.paths['/scim/v2/Users/{scimUserId}'].get
update:
x-apievangelist-phrasing:
intent: Get a user via SCIM
effect: read
questions:
- Can I read one provisioned user through SCIM?
- Can I check a SCIM user's active flag?
instructions:
- text: Get SCIM user {scimUserId}.
slots:
scimUserId: path.scimUserId
- text: Show the SCIM record for {scimUserId}.
slots:
scimUserId: path.scimUserId
method: generated
generated: '2026-09-26'
- target: $.paths['/scim/v2/Users/{scimUserId}'].put
update:
x-apievangelist-phrasing:
intent: Update a user via SCIM
effect: write
questions:
- Can my identity provider update a user's email over SCIM?
- Is there a way to mark a SCIM user inactive without deleting them?
instructions:
- text: 'Update SCIM user {scimUserId}: userName {userName}, name {name}, emails {emails}, schemas {schemas}.'
slots:
scimUserId: path.scimUserId
userName: requestBody.userName
name: requestBody.name
emails: requestBody.emails
schemas: requestBody.schemas
- text: Set SCIM user {scimUserId} active to {active} ({userName}, {name}, {emails}, {schemas}).
slots:
scimUserId: path.scimUserId
active: requestBody.active
userName: requestBody.userName
name: requestBody.name
emails: requestBody.emails
schemas: requestBody.schemas
method: generated
generated: '2026-09-26'
- target: $.paths['/scim/v2/Users/{scimUserId}'].delete
update:
x-apievangelist-phrasing:
intent: De-provision a user via SCIM
effect: destructive
questions:
- How do I de-provision a departed employee over SCIM?
- Can SCIM delete a Gainsight user?
instructions:
- text: De-provision SCIM user {scimUserId}.
slots:
scimUserId: path.scimUserId
- text: Delete user {scimUserId} through SCIM.
slots:
scimUserId: path.scimUserId
method: generated
generated: '2026-09-26'
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.