Support Snyk Learn API reference Product updates Sign up for free

Groups

This document uses the REST API. For more details, see the Authentication for API page.

PreviousGroups (v1)NextIacSettings

Last updated 5 months ago

Was this helpful?

Get list of org memberships of a group user

get

/groups/{group_id}/org_memberships

Authorizations

Path parameters

group_idstring · uuidrequired

The ID of the group

Query parameters

user_idstring · uuidrequired

The ID of the User

org_namestring

Organization name

Example: Org name

role_namestring

Filter the response for results only with the specified role.

starting_afterstring

Return the page of results immediately after this cursor

Example: v1.eyJpZCI6IjEwMDAifQo=

ending_beforestring

Return the page of results immediately before this cursor

Example: v1.eyJpZCI6IjExMDAifQo=

limitinteger · int32 · min: 10 · max: 100 · default: 10

Number of results to return per page

Example: 10

versionstringrequired

Requested API version

Example: 2021-06-04

Pattern:

^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.snyk.io/rest/groups/{group_id}/org_memberships?user_id=123e4567-e89b-12d3-a456-426614174000&version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

409

500

{
  "jsonapi": {
    "version": "1.0"
  },
  "data": [
    {
      "id": "331ede0a-de94-456f-b788-166caeca58bf",
      "org_membership_count": 1,
      "relationships": {
        "org": {
          "data": {
            "id": "331ede0a-de94-456f-b788-166caeca58bf",
            "type": "org",
            "attributes": {
              "name": "Example org"
            }
          }
        },
        "role": {
          "data": {
            "id": "331ede0a-de94-456f-b788-166caeca58bf",
            "type": "org_role",
            "attributes": {
              "name": "Admin role"
            }
          }
        },
        "user": {
          "data": {
            "id": "331ede0a-de94-456f-b788-166caeca58bf",
            "type": "user",
            "attributes": {
              "email": "user@test.com",
              "name": "User2",
              "username": "User name 2"
            }
          }
        }
      },
      "type": "org_membership",
      "attributes": {
        "created_at": "2021-05-29T09:50:54.014Z"
      }
    }
  ],
  "meta": {
    "org_membership_count": 1
  },
  "links": {
    "first": "https://example.com/api/resource",
    "last": "https://example.com/api/resource",
    "next": "https://example.com/api/resource",
    "prev": "https://example.com/api/resource",
    "related": "https://example.com/api/resource",
    "self": "https://example.com/api/resource"
  }
}

A list of org memberships is returned

Create a group membership for a user with role

post

/groups/{group_id}/memberships

Authorizations

Path parameters

group_idstring · uuidrequired

The ID of the group

Query parameters

versionstringrequired

Requested API version

Example: 2021-06-04

Pattern:

^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

Body

dataobject

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.snyk.io/rest/groups/{group_id}/memberships?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"data":{"type":"group_membership","relationships":{"group":{"data":{"id":"8aab168e-fb3b-47c0-9d87-442715788b31","type":"group"}},"role":{"data":{"id":"331ede0a-de94-456f-b788-166caeca58bf","type":"group_role"}},"user":{"data":{"id":"677d5f47-a8bf-4090-ba52-680903e7c8b5","type":"user"}}}}}'

201

400

401

403

404

409

500

{
  "data": {
    "id": "331ede0a-de94-456f-b788-166caeca58bf",
    "relationships": {
      "group": {
        "data": {
          "id": "331ede0a-de94-456f-b788-166caeca58bf",
          "type": "group",
          "attributes": {
            "name": "Example group"
          }
        }
      },
      "role": {
        "data": {
          "id": "331ede0a-de94-456f-b788-166caeca58bf",
          "type": "group_role",
          "attributes": {
            "name": "Admin role"
          }
        }
      },
      "user": {
        "data": {
          "id": "331ede0a-de94-456f-b788-166caeca58bf",
          "type": "user",
          "attributes": {
            "email": "user@test.com",
            "login_method": "text",
            "name": "User2",
            "username": "User name 2"
          }
        }
      }
    },
    "type": "group_membership",
    "attributes": {
      "created_at": "2021-05-29T09:50:54.014Z"
    }
  },
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https://example.com/api/resource",
    "last": "https://example.com/api/resource",
    "next": "https://example.com/api/resource",
    "prev": "https://example.com/api/resource",
    "related": "https://example.com/api/resource",
    "self": "https://example.com/api/resource"
  }
}

Membership for the group was created

Get all memberships of the group

Returns all memberships of the group

get

/groups/{group_id}/memberships

Authorizations

Path parameters

group_idstring · uuidrequired

The ID of the group

Query parameters

starting_afterstring

Return the page of results immediately after this cursor

Example: v1.eyJpZCI6IjEwMDAifQo=

ending_beforestring

Return the page of results immediately before this cursor

Example: v1.eyJpZCI6IjExMDAifQo=

limitinteger · int32 · min: 10 · max: 100 · default: 10

Number of results to return per page

Example: 10

versionstringrequired

Requested API version

Example: 2021-06-04

Pattern:

^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

sort_bystring · enum

Which column to sort by.

Options: username, user_display_name, email, login_method, role_name

sort_orderstring · enum · default: DESC

Order in which results are returned.

Example: ASC

Options: ASC, DESC

emailstring

Filter the response by Users that match the provided email

user_idstring

Filter the response by Users that match the provided user ID

usernamestring

Filter the response by Users that match the provided username

role_namestring

Filter the response for results only with the specified role.

include_group_membership_countboolean

indicates whether the count of group memberships is included

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.snyk.io/rest/groups/{group_id}/memberships?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

500

{
  "data": [
    {
      "attributes": {
        "created_at": "2022-03-16T00:00:00Z"
      },
      "id": "331ede0a-de94-456f-b788-166caeca58bf",
      "meta": {
        "group_membership_count": 1
      },
      "relationships": {
        "group": {
          "data": {
            "id": "331ede0a-de94-456f-b788-166caeca58bf",
            "type": "group",
            "attributes": {
              "name": "Example group"
            }
          }
        },
        "role": {
          "data": {
            "id": "331ede0a-de94-456f-b788-166caeca58bf",
            "type": "group_role",
            "attributes": {
              "name": "Admin role"
            }
          }
        },
        "user": {
          "data": {
            "id": "331ede0a-de94-456f-b788-166caeca58bf",
            "type": "user",
            "attributes": {
              "email": "user@test.com",
              "login_method": "text",
              "name": "User2",
              "username": "User name 2"
            }
          }
        }
      },
      "type": "group_membership"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  },
  "links": {
    "first": "https://example.com/api/resource",
    "last": "https://example.com/api/resource",
    "next": "https://example.com/api/resource",
    "prev": "https://example.com/api/resource",
    "related": "https://example.com/api/resource",
    "self": "https://example.com/api/resource"
  }
}

List of group memberships is returned

Update a role from a group membership

patch

/groups/{group_id}/memberships/{membership_id}

Authorizations

Path parameters

group_idstring · uuidrequired

The ID of the group

membership_idstring · uuidrequired

The ID of the Group Membership

Query parameters

versionstringrequired

Requested API version

Example: 2021-06-04

Pattern:

^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

Body

dataobject

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.snyk.io/rest/groups/{group_id}/memberships/{membership_id}?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN' \
  --header 'Content-Type: application/vnd.api+json' \
  --data '{"data":{"attributes":{},"id":"331ede0a-de94-456f-b788-166caeca58bf","type":"group_membership","relationships":{"role":{"data":{"id":"331ede0a-de94-456f-b788-166caeca58bf","type":"Always \"group_role\""}}}}}'

204

400

401

403

404

500

No body

The operation completed successfully with no content

Delete a membership from a group

Deletes a membership from a group

delete

/groups/{group_id}/memberships/{membership_id}

Authorizations

Path parameters

group_idstring · uuidrequired

The ID of the group

membership_idstring · uuidrequired

The ID of the Group Membership

Query parameters

cascadeboolean

indicates whether to delete the child org memberships of the group membership.

versionstringrequired

Requested API version

Example: 2021-06-04

Pattern:

^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

Responses

application/vnd.api+json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.snyk.io/rest/groups/{group_id}/memberships/{membership_id}?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

204

400

401

403

404

409

500

No body

group membership is deleted from Group