Users

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

My User Details

Retrieves information about the the user making the request.

GEThttps://api.snyk.io/rest/self

Query parameters

Response

200400401403404500

Current user is returned

Headers

Body

application/vnd.api+json

data*Principal20240422 (object)

jsonapi*JsonApi (object)

links*Links (object)

Request

JavaScriptCurlPythonHTTP

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

Response

200400401403404500

{
  "data": {
    "attributes": {
      "avatar_url": "https://snyk.io/avatar.png",
      "default_org_context": "123e4567-e89b-12d3-a456-426614174000",
      "email": "[e-mail]",
      "name": "user",
      "username": "username"
    },
    "id": "55a348e2-c3ad-4bbc-b40e-9b232d1f4121",
    "type": "user"
  },
  "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"
  }
}