Users (v1)

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

Get User Details

Retrieves information about a user.

GEThttps://api.snyk.io/v1/user/{userId}

Path parameters

userId*string

The users ID. The API_KEY must have admin access to at least one group or organization where the requested user is a member and must have the api entitlement on their preferred organization.

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

Header parameters

Response

200400401404

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.

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/user/{userId}', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json; charset=utf-8"
    },
});
const data = await response.json();

Response

200400401404

{
  "id": "",
  "name": "",
  "username": "",
  "email": ""
}

Get My Details

Retrieves information about the the user making the request.

GEThttps://api.snyk.io/v1/user/me

Header parameters

Response

200401

Body

application/json; charset=utf-8

idstring

The id of the user.

usernamestring

The username of the user.

emailstring

The email of the user.

orgsarray of string

The organizations that the user belongs to.

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/user/me', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json; charset=utf-8"
    },
});
const data = await response.json();

Response

200401

{
  "id": "",
  "username": "",
  "email": "",
  "orgs": []
}

Modify organization notification settings

The organization notification settings for the user that will determine which emails are sent.

PUThttps://api.snyk.io/v1/user/me/notification-settings/org/{orgId}

Path parameters

orgId*string

The organization ID. The API_KEY must have access to this organization.

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

Body

application/json; charset=utf-8

new-issues-remediationsNewissuesnotificationsettingrequest

project-importedSimplenotificationsettingrequest

test-limitSimplenotificationsettingrequest

weekly-reportSimplenotificationsettingrequest

any

Response

200

Body

application/json; charset=utf-8

new-issues-remediationsNotificationsettingresponse

project-importedSimplenotificationsettingresponse

test-limitSimplenotificationsettingresponse

weekly-reportSimplenotificationsettingresponse

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/user/me/notification-settings/org/{orgId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; charset=utf-8"
    },
    body: JSON.stringify({
      "new-issues-remediations": {
        "enabled": true,
        "issueSeverity": "high",
        "issueType": "vuln"
      },
      "project-imported": {
        "enabled": true
      },
      "test-limit": {
        "enabled": true
      },
      "weekly-report": {
        "enabled": true
      }
    }),
});
const data = await response.json();

Response

200

{
  "new-issues-remediations": {
    "enabled": true,
    "issueSeverity": "high",
    "issueType": "vuln",
    "inherited": false
  },
  "project-imported": {
    "enabled": true,
    "inherited": false
  },
  "test-limit": {
    "enabled": true,
    "inherited": false
  },
  "weekly-report": {
    "enabled": true,
    "inherited": false
  }
}

Get organization notification settings

The organization notification settings for the user that will determine which emails are sent.

GEThttps://api.snyk.io/v1/user/me/notification-settings/org/{orgId}

Path parameters

orgId*string

The organization ID. The API_KEY must have access to this organization.

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

Header parameters

Response

200

Body

application/json; charset=utf-8

new-issues-remediationsNotificationsettingresponse

project-importedSimplenotificationsettingresponse

test-limitSimplenotificationsettingresponse

weekly-reportSimplenotificationsettingresponse

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/user/me/notification-settings/org/{orgId}', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json; charset=utf-8"
    },
});
const data = await response.json();

Response

200

{
  "new-issues-remediations": {
    "enabled": true,
    "issueSeverity": "high",
    "issueType": "vuln",
    "inherited": false
  },
  "project-imported": {
    "enabled": true,
    "inherited": false
  },
  "test-limit": {
    "enabled": true,
    "inherited": false
  },
  "weekly-report": {
    "enabled": true,
    "inherited": false
  }
}

Modify project notification settings

The project notification settings for the user that will determine which emails are sent.

PUThttps://api.snyk.io/v1/user/me/notification-settings/org/{orgId}/project/{projectId}

Path parameters

orgId*string

The organization ID. The API_KEY must have access to this organization.

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

projectId*string

The project ID to return notification settings for.

Example: "6d5813be-7e6d-4ab8-80c2-1e3e2a454545"

Body

application/json; charset=utf-8

new-issues-remediationsNewissuesnotificationsettingrequest

any

Response

200

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/user/me/notification-settings/org/{orgId}/project/{projectId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; charset=utf-8"
    },
    body: JSON.stringify({
      "new-issues-remediations": {
        "enabled": true,
        "issueSeverity": "high",
        "issueType": "vuln"
      }
    }),
});
const data = await response.json();

Get project notification settings

The project notification settings for the user that will determine which emails are sent.

GEThttps://api.snyk.io/v1/user/me/notification-settings/org/{orgId}/project/{projectId}

Path parameters

orgId*string

The organization ID. The API_KEY must have access to this organization.

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

projectId*string

The project ID to return notification settings for.

Example: "6d5813be-7e6d-4ab8-80c2-1e3e2a454545"

Header parameters

Response

200

Body

application/json; charset=utf-8

new-issues-remediationsNotificationsettingresponse

project-importedSimplenotificationsettingresponse

test-limitSimplenotificationsettingresponse

weekly-reportSimplenotificationsettingresponse

any

Request

JavaScriptCurlPython

const response = await fetch('https://api.snyk.io/v1/user/me/notification-settings/org/{orgId}/project/{projectId}', {
    method: 'GET',
    headers: {
      "Content-Type": "application/json; charset=utf-8"
    },
});
const data = await response.json();

Response

200

{
  "new-issues-remediations": {
    "enabled": true,
    "issueSeverity": "high",
    "issueType": "vuln",
    "inherited": false
  },
  "project-imported": {
    "enabled": true,
    "inherited": false
  },
  "test-limit": {
    "enabled": true,
    "inherited": false
  },
  "weekly-report": {
    "enabled": true,
    "inherited": false
  }
}