Snyk Groups API
The Groups API from Snyk — 7 operation(s) for groups.
Operations 9
Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay
Ask an LLM
“Which Snyk groups am I a member of?”
“Can I page through all my groups?”
Tell an agent
List the groups I'm a member of.
Show the first {limit} of my groups.
Ask an LLM
“Who are the members of my group and what roles do they have?”
“Can I find a group member by email or role?”
Tell an agent
List all memberships of group {group_id}.
Find group {group_id} memberships for email {email}.
POST
/groups/{group_id}/memberships
Add a user to a group with a role · Create a group membership for a user with role
#
Ask an LLM
“How do I add a user to a group with a specific role?”
“Can I grant someone group membership through the API?”
Tell an agent
Add this user to group {group_id} with the admin role.
Create a group membership in group {group_id} for a user and role.
DELETE
/groups/{group_id}/memberships/{membership_id}
Remove a membership from a group · Delete a membership from a group
#
Ask an LLM
“Can I remove a user's membership from a group?”
“Does removing a group membership also cascade to their org memberships?”
Tell an agent destructive · confirm first
Delete membership {membership_id} from group {group_id}.
Remove membership {membership_id} from group {group_id} with cascade set to {cascade}.
PATCH
/groups/{group_id}/memberships/{membership_id}
Change a user's role in a group membership · Update a role from a group membership
#
Ask an LLM
“Can I change the role on someone's existing group membership?”
“What's the way to promote a group member to a different role?”
Tell an agent
Update the role on membership {membership_id} in group {group_id}.
Change group {group_id} membership {membership_id} to the viewer role.
GET
/groups/{group_id}/org_memberships
List a group user's org memberships · Get list of org memberships of a group user
#
Ask an LLM
“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?”
Tell an agent
List the org memberships of user {user_id} in group {group_id}.
Show user {user_id}'s org memberships in group {group_id} for orgs named {org_name}.
GET
/groups/{group_id}/sso_connections
List a group's SSO connections · Get all SSO connections for a group (Early Access)
#
Ask an LLM
“Which SSO connections are configured for my group?”
“Can I see the single sign-on setups tied to a group?”
Tell an agent
List the SSO connections for group {group_id}.
Show group {group_id}'s single sign-on connections.
GET
/groups/{group_id}/sso_connections/{sso_id}/users
List users signing in through an SSO connection · Get all users using a given SSO connection (Early Access)
#
Ask an LLM
“Which users log in through a specific SSO connection?”
“Can I page through everyone using one of my group's SSO connections?”
Tell an agent
List users of SSO connection {sso_id} in group {group_id}.
Show the first {limit} users on group {group_id} SSO connection {sso_id}.
DELETE
/groups/{group_id}/sso_connections/{sso_id}/users/{user_id}
Remove a user from a group SSO connection · Delete a user from a Group SSO connection (Early Access)
#
Ask an LLM
“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?”
Tell an agent destructive · confirm first
Delete user {user_id} from SSO connection {sso_id} in group {group_id}.
Remove SSO user {user_id} from group {group_id} connection {sso_id}.
Documentation
Documentation
https://apidocs.snyk.io/?version=2024-10-15
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Orgs
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Projects
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Issues
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Targets
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Integrations
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Audit-Logs
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/SBOM
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Container-Images
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Custom-Base-Images
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Webhooks
Documentation
https://apidocs.snyk.io/?version=2024-10-15#tag/Issues-Export
Specifications
Schemas & Data
JSONSchema
https://artifacts.apis.io/snyk/json-schema/snyk-create-group-membership-request-body-schema.json
JSONSchema
https://artifacts.apis.io/snyk/json-schema/snyk-user-schema.json
JSONSchema
https://artifacts.apis.io/snyk/json-schema/snyk-membership-patch-request-body-schema.json
JSONSchema
https://artifacts.apis.io/snyk/json-schema/snyk-group-membership-org-membership-schema.json
JSONSchema
https://artifacts.apis.io/snyk/json-schema/snyk-group-membership-schema.json
JSONSchema
https://artifacts.apis.io/snyk/json-schema/snyk-group-membership-response-data-schema.json