v1

latestOpenAPI 3.0.02026-07-141,4077,1665.2 MB

Users

Anonymize users

Anonymize a list of users, removing their personal data. This operation is irreversible. Requires the user_access_manage permission.

put/api/v2/anonymize_users

Request body

Example request

{
  "data": {
    "attributes": {
      "user_ids": [
        "00000000-0000-0000-0000-000000000000"
      ]
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "anonymize_users_request"
  }
}

Response

Example response

{
  "data": {
    "attributes": {
      "anonymize_errors": [
        {
          "user_id": "00000000-0000-0000-0000-000000000000"
        }
      ],
      "anonymized_user_ids": [
        "00000000-0000-0000-0000-000000000000"
      ]
    },
    "id": "00000000-0000-0000-0000-000000000000",
    "type": "anonymize_users_response"
  }
}