Generated by API Evangelist
Written by API Evangelist tooling for Snyk's API. It is a proposal applied on top of the contract, not a document Snyk publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Snyk Users API
version: 1.0.0
extends: openapi/snyk-users-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: 3
- target: $.paths['/groups/{group_id}/users/{id}'].patch
update:
x-apievangelist-phrasing:
intent: Remove a user's membership from a group
effect: destructive
questions:
- Can I take a user out of a group by setting their membership to null?
- Does the group user update endpoint support changing roles, or only removal?
instructions:
- text: Remove user {id} from group {group_id} by clearing their membership.
slots:
id: path.id
group_id: path.group_id
- text: Revoke group {group_id} membership for user {id}.
slots:
group_id: path.group_id
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/orgs/{org_id}/users/{id}'].get
update:
x-apievangelist-phrasing:
intent: Get a user in an organization by ID
effect: read
questions:
- Can I look up a summary of a user in my organization?
- Why doesn't a service account show up when I fetch a user by ID?
instructions:
- text: Get user {id} in organization {org_id}.
slots:
id: path.id
org_id: path.org_id
- text: Show a summary of org {org_id} user {id}.
slots:
org_id: path.org_id
id: path.id
method: generated
generated: '2026-09-26'
- target: $.paths['/self'].get
update:
x-apievangelist-phrasing:
intent: Get my own user details
effect: read
questions:
- Which Snyk user is my API token authenticated as?
- What does my own user profile look like through the API?
instructions:
- text: Show my user details.
- text: Tell me who I'm authenticated as, using API version {version}.
slots:
version: query.version
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.