Support Snyk Learn API reference Product updates Sign up for free

Users (v1)

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

PreviousTest (v1)NextUsers

Last updated 6 months ago

Was this helpful?

Get User Details

Retrieves information about a user.

get

/user/{userId}

Path parameters

userIdstringrequired

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

Content-Typestring · enumrequired

Example: application/json; charset=utf-8

Options: application/json; charset=utf-8

Responses

application/json; charset=utf-8

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.snyk.io/v1/user/{userId}' \
  --header 'Content-Type: application/json; charset=utf-8'

200

400

401

404

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

Get My Details

Retrieves information about the the user making the request.

get

/user/me

Header parameters

Content-Typestring · enumrequired

Example: application/json; charset=utf-8

Options: application/json; charset=utf-8

Responses

application/json; charset=utf-8

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.snyk.io/v1/user/me' \
  --header 'Content-Type: application/json; charset=utf-8'

200

401

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

Modify organization notification settings

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

put

/user/me/notification-settings/org/{orgId}

Path parameters

orgIdstringrequired

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

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

Body

new-issues-remediationsNewissuesnotificationsettingrequest

project-importedSimplenotificationsettingrequest

test-limitSimplenotificationsettingrequest

weekly-reportSimplenotificationsettingrequest

any

Example:

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

Responses

application/json; charset=utf-8

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.snyk.io/v1/user/me/notification-settings/org/{orgId}' \
  --header 'Content-Type: application/json; charset=utf-8' \
  --data '{"new-issues-remediations":{"enabled":true,"issueSeverity":"high","issueType":"vuln"},"project-imported":{"enabled":true},"test-limit":{"enabled":true},"weekly-report":{"enabled":true}}'

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.

get

/user/me/notification-settings/org/{orgId}

Path parameters

orgIdstringrequired

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

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

Header parameters

Content-Typestring · enumrequired

Example: application/json; charset=utf-8

Options: application/json; charset=utf-8

Responses

application/json; charset=utf-8

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.snyk.io/v1/user/me/notification-settings/org/{orgId}' \
  --header 'Content-Type: application/json; charset=utf-8'

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.

put

/user/me/notification-settings/org/{orgId}/project/{projectId}

Path parameters

orgIdstringrequired

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

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

projectIdstringrequired

The project ID to return notification settings for.

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

Body

new-issues-remediationsNewissuesnotificationsettingrequest

any

Example: {"new-issues-remediations":{"enabled":true,"issueSeverity":"high","issueType":"vuln"}}

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://api.snyk.io/v1/user/me/notification-settings/org/{orgId}/project/{projectId}' \
  --header 'Content-Type: application/json; charset=utf-8' \
  --data '{"new-issues-remediations":{"enabled":true,"issueSeverity":"high","issueType":"vuln"}}'

200

No body

Get project notification settings

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

get

/user/me/notification-settings/org/{orgId}/project/{projectId}

Path parameters

orgIdstringrequired

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

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

projectIdstringrequired

The project ID to return notification settings for.

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

Header parameters

Content-Typestring · enumrequired

Example: application/json; charset=utf-8

Options: application/json; charset=utf-8

Responses

application/json; charset=utf-8

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.snyk.io/v1/user/me/notification-settings/org/{orgId}/project/{projectId}' \
  --header 'Content-Type: application/json; charset=utf-8'

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
  }
}