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.

get

/self

Authorizations

BearerAuthAPIToken

Query parameters

versionstringrequired

Requested API version

Example: 2021-06-04

Pattern: ^(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

application/vnd.api+json

application/vnd.api+json

application/vnd.api+json

application/vnd.api+json

application/vnd.api+json

application/vnd.api+json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.snyk.io/rest/self?version=text' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

200

400

401

403

404

500

200

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

Current user is returned