Skip to main content
POST
/
v1
/
users
Create a new member/admin
curl --request POST \
  --url https://api.synack.com/v1/users \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "admin": false,
  "assessments": [
    "<string>"
  ],
  "send_invite": true
}
'
{
  "id": 123,
  "email": "<string>",
  "assessment_ids": [
    "<string>"
  ],
  "banned": true,
  "admin": true,
  "invite_url": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Body

application/json

Request body.

​
email
string
required

E-mail address for the user

​
first_name
string

First name of the user

​
last_name
string

Last name of the user

​
admin
boolean
default:false

Flag to indicate whether to grant admin privileges

​
assessments
string[]

IDs of assessments to grant user access to

​
send_invite
boolean
default:true

Flag to indicate whether to send the user the invitation URL by e-mail

Response

The newly created user

​
id
integer<int64>
required
​
email
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)