Groups (v1)

This document uses the v1 API. For more details, see the v1 API.

List all tags in a group

GEThttps://api.snyk.io/v1/group/{groupId}/tags

Path parameters

groupId*string

The group ID. The API_KEY must have access admin to this group.

Example: "4a18d42f-0706-4ad0-b127-24078731fbed"

Query parameters

Header parameters

Response

200

Headers

Body

application/json; charset=utf-8

tagsarray of Tagbody

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/group/{groupId}/tags', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

200

{
  "tags": [
    {
      "key": "meta",
      "value": "Alfa"
    },
    {
      "key": "meta",
      "value": "Bravo"
    },
    {
      "key": "meta",
      "value": "Charlie"
    },
    {
      "key": "meta",
      "value": "Delta"
    },
    {
      "key": "meta",
      "value": "Echo"
    },
    {
      "key": "meta",
      "value": "Foxtrot"
    },
    {
      "key": "meta",
      "value": "Golf"
    },
    {
      "key": "meta",
      "value": "Hotel"
    },
    {
      "key": "meta",
      "value": "India"
    },
    {
      "key": "meta",
      "value": "Juliet"
    }
  ]
}

Delete tag from group

POSThttps://api.snyk.io/v1/group/{groupId}/tags/delete

Path parameters

groupId*string

The group ID. The API_KEY must have access admin to this group.

Example: "4a18d42f-0706-4ad0-b127-24078731fbed"

Body

application/json

keystring

Valid tag key.

valuestring

Valid tag value.

forceboolean

force delete tag that has entities (default is false).

any

Response

200

Body

application/json; charset=utf-8

keystring

Valid tag key.

valuestring

Valid tag value.

forceboolean

force delete tag that has entities (default is false).

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/group/{groupId}/tags/delete', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "key": "",
      "value": "",
      "force": false
    }),
});
const data = await response.json();

Response

200

{
  "key": "",
  "value": "",
  "force": false
}

Update group settings

PUThttps://api.snyk.io/v1/group/{groupId}/settings

Path parameters

groupId*string

The group ID. The API_KEY must have admin access to this group.

Example: "b61bc07c-27c6-42b3-8b04-0f228ed31a67"

Body

application/json

requestAccessall of

sessionLengthnumber

The new session length for the group in minutes. This must be an integer between 1 and 43200 (30 days). Setting this value to null will result in this group inheriting from the global default of 30 days.

any

Response

200

Body

application/json; charset=utf-8

requestAccessall of

sessionLengthnumber

The new session length for the group in minutes. This must be an integer between 1 and 43200 (30 days). Setting this value to null will result in this group inheriting from the global default of 30 days.

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/group/{groupId}/settings', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "sessionLength": 50,
      "requestAccess": {
        "enabled": true
      }
    }),
});
const data = await response.json();

Response

200

{
  "requestAccess": {
    "enabled": true
  },
  "sessionLength": 50
}

View group settings

GEThttps://api.snyk.io/v1/group/{groupId}/settings

Path parameters

groupId*string

The group ID. The API_KEY must have admin access to this group.

Example: "b61bc07c-27c6-42b3-8b04-0f228ed31a67"

Header parameters

Response

200

Body

application/json; charset=utf-8

requestAccessall of

sessionLengthnumber

The new session length for the group in minutes. This must be an integer between 1 and 43200 (30 days). Setting this value to null will result in this group inheriting from the global default of 30 days.

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/group/{groupId}/settings', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

200

{
  "requestAccess": {
    "enabled": true
  },
  "sessionLength": 0
}

List all roles in a group

GEThttps://api.snyk.io/v1/group/{groupId}/roles

Path parameters

groupId*string

The group ID. The API_KEY must have READ access to this group.

Example: "a060a49f-636e-480f-9e14-38e773b2a97f"

Header parameters

Response

200

Body

application/json; charset=utf-8

name*string

description*string

publicId*string

created*string

modified*string

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/group/{groupId}/roles', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

200

[
  {
    "name": "Org Collaborator",
    "description": "<p>Collaborator</p>",
    "publicId": "6525b356-a400-465f-b2e5-3eee1161e69f",
    "created": "2021-04-22T16:02:53.233Z",
    "modified": "2021-04-22T16:02:53.332Z",
    "__$markdownParsed": true
  },
  {
    "name": "Org Admin",
    "description": "<p>Admin</p>",
    "publicId": "af047fef-69f3-4bd9-9760-8957ce0d2ece",
    "created": "2021-04-22T16:02:53.233Z",
    "modified": "2021-04-22T16:02:53.332Z",
    "__$markdownParsed": true
  }
]

List all organizations in a group

GEThttps://api.snyk.io/v1/group/{groupId}/orgs

Path parameters

groupId*string

The group ID. The API_KEY must have READ access to this group and LIST organizations access in this group.

Example: "a060a49f-636e-480f-9e14-38e773b2a97f"

Query parameters

Header parameters

Response

200

Body

application/json; charset=utf-8

id*string

name*string

url*string

created*string

orgs*array of Orgs1

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/group/{groupId}/orgs', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

200

{
  "id": "a060a49f-636e-480f-9e14-38e773b2a97f",
  "name": "ACME Inc.",
  "url": "https://api.snyk.io/v1/group/0dfc509a-e7a9-48ef-9d39-649d6468fc09",
  "created": "2021-06-07T00:00:00.000Z",
  "orgs": [
    {
      "name": "myDefaultOrg",
      "id": "689ce7f9-7943-4a71-b704-2ba575f01089",
      "slug": "my-default-org",
      "url": "https://api.snyk.io/v1/org/default-org",
      "created": "2021-06-07T00:00:00.000Z"
    },
    {
      "name": "My Other Org",
      "id": "a04d9cbd-ae6e-44af-b573-0556b0ad4bd2",
      "slug": "my-other-org",
      "url": "https://api.snyk.io/v1/org/my-other-org",
      "created": "2021-06-07T00:00:00.000Z"
    }
  ]
}

Add a member to an organization within a group

POSThttps://api.snyk.io/v1/group/{groupId}/org/{orgId}/members

Path parameters

groupId*string

The group ID. The API_KEY must have access admin to this group.

Example: "4a18d42f-0706-4ad0-b127-24078731fbed"

orgId*string

The organization ID we want to add the member to. The API_KEY must have access to this organization.

Example: "4a18d42f-0706-4ad0-b127-24078731fbed"

Body

application/json

userIdstring

The id of the user.

rolestring

The role of the user, "admin" or "collaborator".

any

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/group/{groupId}/org/{orgId}/members', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "userId": "",
      "role": ""
    }),
});
const data = await response.json();

List all members in a group

Note: Requests to this endpoint are limited to one per minute. Additional requests within this time will receive a 429 Too Many Requests response.

GEThttps://api.snyk.io/v1/group/{groupId}/members

Path parameters

groupId*string

The group ID. The API_KEY must have access admin to this group.

Example: "4a18d42f-0706-4ad0-b127-24078731fbed"

Header parameters

Response

200

Body

application/json; charset=utf-8

idstring

The id of the user.

namestring

The name of the user.

usernamestring

The username of the user.

emailstring

The email of the user (email is null if the member is a service account).

orgsarray of orgs

groupRolestring

(Optional) The role of the user in the group.

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/group/{groupId}/members', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json"
    },
});
const data = await response.json();

Response

200

[
  {
    "id": "",
    "name": "",
    "username": "",
    "email": "",
    "orgs": [
      {
        "name": "",
        "role": ""
      }
    ],
    "groupRole": ""
  }
]