Generated by API Evangelist
Written by API Evangelist tooling for Vendasta's API. It is a proposal applied on top of the contract, not a document Vendasta publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for SCIM 2.0 User Management Group API
version: 1.0.0
extends: openapi/vendasta-group-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-10-01'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 3
- target: $.paths['/{namespace}/Groups'].get
update:
x-apievangelist-phrasing:
intent: Search a partner's user groups
effect: read
questions:
- Can I find a SCIM group by its display name, like Platform Admin?
- Which groups exist under my partner, without listing their members?
instructions:
- text: List groups in partner namespace {namespace}.
slots:
namespace: path.namespace
- text: Search groups in {namespace} using filter {filter}.
slots:
namespace: path.namespace
filter: query.filter
method: generated
generated: '2026-10-01'
- target: $.paths['/{namespace}/Groups/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get one user group
effect: read
questions:
- Who are the members of a particular SCIM group?
- Can I fetch a single group by ID and leave out its member list?
instructions:
- text: Get group {id} in partner namespace {namespace}.
slots:
id: path.id
namespace: path.namespace
- text: Show group {id} from {namespace} excluding {excludedAttributes}.
slots:
id: path.id
namespace: path.namespace
excludedAttributes: query.excludedAttributes
method: generated
generated: '2026-10-01'
- target: $.paths['/{namespace}/Groups/{id}'].patch
update:
x-apievangelist-phrasing:
intent: Update a user group's members or attributes
effect: write
questions:
- How do I add or remove members from a SCIM group?
- Can I patch a group without replacing it entirely?
instructions:
- text: Patch group {id} in {namespace} with operations {Operations}.
slots:
id: path.id
namespace: path.namespace
Operations: requestBody.Operations
- text: Update the members of group {id} in partner {namespace}.
slots:
id: path.id
namespace: path.namespace
method: generated
generated: '2026-10-01'
Discovery needs no key. Ratings and market analysis are Pro.
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.