Groups

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

Get list of org memberships of a group user

Get list of org memberships of a group user

GEThttps://api.snyk.io/rest/groups/{group_id}/org_memberships

Path parameters

group_id*string (uuid)

The ID of the group

Query parameters

Response

200400401403404409500

A list of org memberships is returned

Headers

Body

application/vnd.api+json

data*array of GroupMembershipOrgMembership (object)

jsonapi*JsonApi (object)

links*Links (object)

metaobject

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/groups/{group_id}/org_memberships?user_id=123e4567-e89b-12d3-a456-426614174000&version=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404409500

{
  "data": [
    {
      "attributes": {
        "created_at": "2021-05-29T09:50:54.014Z"
      },
      "id": "331ede0a-de94-456f-b788-166caeca58bf",
      "org_membership_count": 0,
      "relationships": {
        "org": {
          "data": {
            "attributes": {
              "name": "Example org"
            },
            "id": "331ede0a-de94-456f-b788-166caeca58bf",
            "type": "org"
          }
        },
        "role": {
          "data": {
            "attributes": {
              "name": "Admin role"
            },
            "id": "331ede0a-de94-456f-b788-166caeca58bf",
            "type": "org_role"
          }
        },
        "user": {
          "data": {
            "attributes": {
              "email": "[e-mail]",
              "name": "User2",
              "username": "User name 2"
            },
            "id": "331ede0a-de94-456f-b788-166caeca58bf",
            "type": "user"
          }
        }
      },
      "type": "org_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"
  },
  "meta": {
    "org_membership_count": 0
  }
}

Create a group membership for a user with role

Create a group membership for a user with role

POSThttps://api.snyk.io/rest/groups/{group_id}/memberships

Path parameters

group_id*string (uuid)

The ID of the group

Query parameters

Body

application/vnd.api+json

dataobject

Response

201400401403404409500

Membership for the group was created

Headers

Body

application/vnd.api+json

dataGroupMembership (object)

jsonapiJsonApi (object)

linksLinks (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/groups/{group_id}/memberships?version=text', {
    method: 'POST',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

201400401403404409500

{
  "data": {
    "attributes": {
      "created_at": "2021-05-29T09:50:54.014Z"
    },
    "id": "331ede0a-de94-456f-b788-166caeca58bf",
    "relationships": {
      "group": {
        "data": {
          "attributes": {
            "name": "Example group"
          },
          "id": "331ede0a-de94-456f-b788-166caeca58bf",
          "type": "group"
        }
      },
      "role": {
        "data": {
          "attributes": {
            "name": "Admin role"
          },
          "id": "331ede0a-de94-456f-b788-166caeca58bf",
          "type": "group_role"
        }
      },
      "user": {
        "data": {
          "attributes": {
            "email": "[e-mail]",
            "login_method": "text",
            "name": "User2",
            "username": "User name 2"
          },
          "id": "331ede0a-de94-456f-b788-166caeca58bf",
          "type": "user"
        }
      }
    },
    "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"
  }
}

Get all memberships of the group

Returns all memberships of the group

GEThttps://api.snyk.io/rest/groups/{group_id}/memberships

Path parameters

group_id*string (uuid)

The ID of the group

Query parameters

Response

200400401403404500

List of group memberships is returned

Headers

Body

application/vnd.api+json

data*GroupMembershipResponseData (array of object)

jsonapi*JsonApi (object)

links*Links (object)

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/groups/{group_id}/memberships?version=text', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401403404500

{
  "data": [
    {
      "attributes": {
        "created_at": "2022-03-16T00:00:00Z"
      },
      "id": "331ede0a-de94-456f-b788-166caeca58bf",
      "meta": {
        "group_membership_count": 0
      },
      "relationships": {
        "group": {
          "data": {
            "attributes": {
              "name": "Example group"
            },
            "id": "331ede0a-de94-456f-b788-166caeca58bf",
            "type": "group"
          }
        },
        "role": {
          "data": {
            "attributes": {
              "name": "Admin role"
            },
            "id": "331ede0a-de94-456f-b788-166caeca58bf",
            "type": "group_role"
          }
        },
        "user": {
          "data": {
            "attributes": {
              "email": "[e-mail]",
              "login_method": "text",
              "name": "User2",
              "username": "User name 2"
            },
            "id": "331ede0a-de94-456f-b788-166caeca58bf",
            "type": "user"
          }
        }
      },
      "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"
  }
}

Update a role from a group membership

Update a role from a group membership

PATCHhttps://api.snyk.io/rest/groups/{group_id}/memberships/{membership_id}

Path parameters

group_id*string (uuid)

The ID of the group

membership_id*string (uuid)

The ID of the Group Membership

Query parameters

Body

application/vnd.api+json

dataMembershipPatchRequestBody (object)

Response

204400401403404500

The operation completed successfully with no content

Headers

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/groups/{group_id}/memberships/{membership_id}?version=text', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/vnd.api+json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

400401403404500

{
  "errors": [
    {
      "detail": "Permission denied for this resource",
      "status": "403"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}

Delete a membership from a group

Deletes a membership from a group

DELETEhttps://api.snyk.io/rest/groups/{group_id}/memberships/{membership_id}

Path parameters

group_id*string (uuid)

The ID of the group

membership_id*string (uuid)

The ID of the Group Membership

Query parameters

Response

204400401403404409500

group membership is deleted from Group

Headers

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/rest/groups/{group_id}/memberships/{membership_id}?version=text', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401403404409500

{
  "errors": [
    {
      "detail": "Permission denied for this resource",
      "status": "403"
    }
  ],
  "jsonapi": {
    "version": "1.0"
  }
}