Feedback API
- 26 Oct 2023
- Print
- DarkLight
Feedback API
- Updated on 26 Oct 2023
- Print
- DarkLight
Article Summary
Share feedback
Thanks for sharing your feedback!
Feedback API allows you to define automated user status updates. Also, you can use Feedback API to resolve True Positive or False Positive cases and create a new incident (False Negative), while adding your comments.
Requests
Requests must be sent over HTTPS using a content type of application/json
and include the Authorization header that is used for authentication.
Header | Description |
---|---|
Authorization | Token to provide authentication |
Content-Type | Value is always application/json |
All requests are made to the base URL of https://console.humansecurity.com/api/v1/account_defender/account/update_status
Authentication
To access the Feedback API:
- Generate an authentication token as explained in Setting up your Application.
- Paste the authentication token into the HTTP Authorization header.
Authorization: Bearer <TOKEN>
Endpoint
HTTP Method | Request URL |
---|---|
POST | https://console.humansecurity.com/api/v1/account_defender/account/update_status |
Request Schema
Parameter | Type | Value | Required/Optional |
---|---|---|---|
accountIds | Array of strings | NA | Required |
attackType | String | 'fa', 'ato' | Required |
status | String | 'pending', 'resolved' | Required |
result | String | 'no_attack', 'resolved', 'manually_identified_and_resolved', 'manually_identified' | Optional - relevant when status is 'resolved' |
comment | String | Free text | Optional |
Example
curl -X POST \
-H "Authorization: Bearer <JWT>" \
-H "Content-Type: application/json" \
-d '{
"accountIds": ["accountId"],
"attackType": "fa",
"status": "resolved",
"result": "no_attack",
"comment": "test"
}' \
"https://console.humansecurity.com/api/v1/account_defender/account/update_status"
Response Schema
Code | Result | Description |
---|---|---|
200 | Success | |
400 | Error | Invalid value - mismatched values in request entities |
401 | Error | Invalid authorization token |
Was this article helpful?