Sign in

v1

latestOpenAPI 3.0.32026-07-134103031.5 MB
API Users

Create API User

post/api-users/

Request body

namestring required

Name of the user.

title'ceo' | 'cto' | 'cso' | 'seceng' | 'dev' | 'devop' | 'manager' | 'other' | ''

Job title:

  • ceo - Chief Executive Officer
  • cto - Chief Technology Officer
  • cso - Chief Security Officer
  • seceng - Security engineer
  • dev - Developer
  • devop - Developer Operations
  • manager - Manager
  • other - Other
activeboolean

If true, the user can authenticate to Snyk API & Web to interact with apps and the API.
If false, the user's access to Snyk API & Web's apps and API is blocked.
Defaults to true.

days_valid_forinteger

Response

idstring required

A unique Base58 value identifying this object.

namestring required

Name of the user.

changedstring date-time required

Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".

activeboolean

If true, the user can authenticate to Snyk API & Web to interact with apps and the API.
If false, the user's access to Snyk API & Web's apps and API is blocked.
Defaults to true.

is_apiuserboolean required

If true, it is an app that interacts with Snyk API & Web through the API.
If false, it is a human who interacts with Snyk API & Web through our web interface.
Defaults to false."

keystring required
expiration_datestring date-time nullable required
days_valid_forinteger