Remove members from Groups and Orgs using the API

To remove members from Groups and Organizations programmatically from user user accounts, you can use the API V1 and REST as explained in the steps that follow. You cannot use these API calls to remove service accounts.

Remove Organization memberships

Step 1: Get a list of Organization members

Request: GET https://snyk.io/api/v1/org/{orgId}/members

API documentation: https://snyk.docs.apiary.io/#reference/organizations/members-in-organization/list-members

This call returns an array of all non-admin members of the Organization. Save the id of each user who needs to be removed from the Organization.

Step 2: Remove a member from an Organization

Request: DELETE https://snyk.io/api/v1/org/{orgId}/members/update/{userId}

API documentation: https://snyk.docs.apiary.io/#reference/organizations/manage-roles-in-organization/remove-a-member-from-the-organization

For each user, call the endpoint to remove that member from the Organization using the user id you saved previously.

For a successful request, the response is 200 OK.

Look at the Organization members page to verify that the member has been removed.

When a member is removed from an Organization, if the Organization is a part of a Group, the user continues to exist in the Group as a Group Member. To completely remove the user from the Group, follow the steps in the next section.

Remove Group memberships

Step 1: Get a list of Group members

Request: GET https://api.snyk.io/api/v1/group/groupId/members

API documentation: https://snyk.docs.apiary.io/#reference/groups/list-members-in-a-group/list-all-members-in-a-group

This call returns an array of all members of the Group. Save the id of each user who needs to be removed from the Group.

Step 2: Remove a member from a Group

Request: PATCH https://api.snyk.io/rest/groups/{group_id}/users/{id}?version=2023-01-30~beta

API documentation: https://apidocs.snyk.io/?version=2024-06-18%7Ebeta#patch-/groups/-group_id-/users/-id-

Body:

{
    "data": {
        "attributes": {
            "membership": null
        },
        "id": "<user-id>",
        "type": "user"
    }
}

For each user, call the endpoint to remove that member from the Group using the user id you saved previously.

For a successful request, the response is 200 OK.

Look at the Group members page to verify the user has been removed.

When a member is removed from a Group, the user continues to exist in Snyk. To completely delete all data associated with the user, follow the step in the next section.

Delete Group members

When an SSO connection is associated with only one Group, the following call can completely delete a Group member from the system. This delete action also complies with the GDPR (General Data Protection Regulation) requirements.

Request: DELETE https://api.snyk.io/rest/groups/{group_id}/sso_connections/{sso_id}/users/{user_id}?version=2023-01-30~beta

API documentation: https://apidocs.snyk.io/?version=2024-06-18%7Ebeta#delete-/groups/-group_id-/sso_connections/-sso_id-/users/-user_id-

You can find the {sso_id} on the Snyk Web UI; navigate to Group >Settings >SSO >Step 3. If you need help, reach out to your Account team.

For a successful request, the response is 200 OK.

Use the following request to verify the member has been deleted. GET https://api.snyk.io/api/v1/user/userId

Last updated

More information

Snyk privacy policy

© 2023 Snyk Limited | All product and company names and logos are trademarks of their respective owners.