Skip to main content
PUT
/
v1
/
users
/
{id}
Update user account status
curl --request PUT \
  --url https://api.synack.com/v1/users/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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.

Path Parameters

​
id
string
required

ID of the user

Query Parameters

​
admin
boolean

Flag to indicate whether to grant/remove admin privileges

​
reactivate
boolean

Flag to indicate whether to reactivate (unban) the user

Response

The updated 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)