Get current user information

GET

users

whoami

curl --request GET \
  --url https://api.synack.com/v1/users/whoami \
  --header 'Authorization: Bearer <token>'

{
  "id": 123,
  "email": "<string>",
  "assessment_ids": [
    "<string>"
  ],
  "banned": true,
  "admin": true,
  "invite_url": "<string>"
}

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

User information retrieved successfully

integer<int64>

required

string

required

e-mail address of the user

assessment_ids

string[]

required

IDs of assessments the user has access to

banned

boolean

required

boolean flag to indicate whether the user has been banned

admin

boolean

boolean flag to indicate whether the user has admin privileges (only visible to admin

invite_url

string

invitation URL (only visible to admins)

⌘I

Get current user information

curl --request GET \
  --url https://api.synack.com/v1/users/whoami \
  --header 'Authorization: Bearer <token>'

{
  "id": 123,
  "email": "<string>",
  "assessment_ids": [
    "<string>"
  ],
  "banned": true,
  "admin": true,
  "invite_url": "<string>"
}