Users

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

My User Details

get

Retrieves information about the the user making the request.

Authorizations

APITokenBearerAuth

Query parameters

versionstringRequired

Requested API version

Example: 2021-06-04Pattern: ^(wip|work-in-progress|experimental|beta|((([0-9]{4})-([0-1][0-9]))-((3[01])|(0[1-9])|([12][0-9]))(~(wip|work-in-progress|experimental|beta))?))$

Responses

get

HTTPcURLJavaScriptPython

GET /rest/self HTTP/1.1
Host: api.snyk.io
Authorization: YOUR_API_KEY
Accept: */*

{
  "data": {
    "attributes": {
      "avatar_url": "https://snyk.io/avatar.png",
      "default_org_context": "123e4567-e89b-12d3-a456-426614174000",
      "email": "[email protected]",
      "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"
  }
}