Delete User Data API
- 22 Jan 2024
- Print
- DarkLight
Delete User Data API
- Updated on 22 Jan 2024
- Print
- DarkLight
Article Summary
Share feedback
Thanks for sharing your feedback!
Delete user data API enables you to request data deletion for specific users. The server will permanently delete all data for the requested user within 30 days after the request.
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/delete_user_data
Authentication
To access the Delete user data 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/delete_user_data |
Request Schema
Parameter | Type | Value | Required/Optional |
---|---|---|---|
user_ids | Array of strings | NA | Required |
Example
curl -X POST \
-H "Authorization: Bearer <JWT>" \
-H "Content-Type: application/json" \
-d '{
"user_ids": ["user_id"]
}' \
"https://console.humansecurity.com/api/v1/account_defender/account/delete_user_data"
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?