# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand. overlay: 1.0.0 info: title: API Evangelist conversational phrasing for Snyk Groups API version: 1.0.0 extends: openapi/snyk-groups-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: 9 - target: $.paths['/groups'].get update: x-apievangelist-phrasing: intent: List the groups I belong to effect: read questions: - Which Snyk groups am I a member of? - Can I page through all my groups? instructions: - text: List the groups I'm a member of. - text: Show the first {limit} of my groups. slots: limit: query.limit method: generated generated: '2026-09-26' - target: $.paths['/groups/{group_id}/memberships'].get update: x-apievangelist-phrasing: intent: List memberships in a group effect: read questions: - Who are the members of my group and what roles do they have? - Can I find a group member by email or role? instructions: - text: List all memberships of group {group_id}. slots: group_id: path.group_id - text: Find group {group_id} memberships for email {email}. slots: group_id: path.group_id email: query.email - text: List group {group_id} members with role {role_name}. slots: group_id: path.group_id role_name: query.role_name method: generated generated: '2026-09-26' - target: $.paths['/groups/{group_id}/memberships'].post update: x-apievangelist-phrasing: intent: Add a user to a group with a role effect: write questions: - How do I add a user to a group with a specific role? - Can I grant someone group membership through the API? instructions: - text: Add this user to group {group_id} with the admin role. slots: group_id: path.group_id - text: Create a group membership in group {group_id} for a user and role. slots: group_id: path.group_id method: generated generated: '2026-09-26' - target: $.paths['/groups/{group_id}/memberships/{membership_id}'].delete update: x-apievangelist-phrasing: intent: Remove a membership from a group effect: destructive questions: - Can I remove a user's membership from a group? - Does removing a group membership also cascade to their org memberships? instructions: - text: Delete membership {membership_id} from group {group_id}. slots: membership_id: path.membership_id group_id: path.group_id - text: Remove membership {membership_id} from group {group_id} with cascade set to {cascade}. slots: membership_id: path.membership_id group_id: path.group_id cascade: query.cascade method: generated generated: '2026-09-26' - target: $.paths['/groups/{group_id}/memberships/{membership_id}'].patch update: x-apievangelist-phrasing: intent: Change a user's role in a group membership effect: write questions: - Can I change the role on someone's existing group membership? - What's the way to promote a group member to a different role? instructions: - text: Update the role on membership {membership_id} in group {group_id}. slots: membership_id: path.membership_id group_id: path.group_id - text: Change group {group_id} membership {membership_id} to the viewer role. slots: group_id: path.group_id membership_id: path.membership_id method: generated generated: '2026-09-26' - target: $.paths['/groups/{group_id}/org_memberships'].get update: x-apievangelist-phrasing: intent: List a group user's org memberships effect: read questions: - Which organizations in my group does a particular user belong to? - Can I filter a user's org memberships in a group by org name or role? instructions: - text: List the org memberships of user {user_id} in group {group_id}. slots: user_id: query.user_id group_id: path.group_id - text: Show user {user_id}'s org memberships in group {group_id} for orgs named {org_name}. slots: user_id: query.user_id group_id: path.group_id org_name: query.org_name method: generated generated: '2026-09-26' - target: $.paths['/groups/{group_id}/sso_connections'].get update: x-apievangelist-phrasing: intent: List a group's SSO connections effect: read questions: - Which SSO connections are configured for my group? - Can I see the single sign-on setups tied to a group? instructions: - text: List the SSO connections for group {group_id}. slots: group_id: path.group_id - text: Show group {group_id}'s single sign-on connections. slots: group_id: path.group_id method: generated generated: '2026-09-26' - target: $.paths['/groups/{group_id}/sso_connections/{sso_id}/users'].get update: x-apievangelist-phrasing: intent: List users signing in through an SSO connection effect: read questions: - Which users log in through a specific SSO connection? - Can I page through everyone using one of my group's SSO connections? instructions: - text: List users of SSO connection {sso_id} in group {group_id}. slots: sso_id: path.sso_id group_id: path.group_id - text: Show the first {limit} users on group {group_id} SSO connection {sso_id}. slots: limit: query.limit group_id: path.group_id sso_id: path.sso_id method: generated generated: '2026-09-26' - target: $.paths['/groups/{group_id}/sso_connections/{sso_id}/users/{user_id}'].delete update: x-apievangelist-phrasing: intent: Remove a user from a group SSO connection effect: destructive questions: - Can I delete a user from one of my group's SSO connections? - What permissions are needed to remove an SSO user from a group? instructions: - text: Delete user {user_id} from SSO connection {sso_id} in group {group_id}. slots: user_id: path.user_id sso_id: path.sso_id group_id: path.group_id - text: Remove SSO user {user_id} from group {group_id} connection {sso_id}. slots: user_id: path.user_id group_id: path.group_id sso_id: path.sso_id method: generated generated: '2026-09-26'