delete User With Id
DELETE {{baseUrl}}/api/user/:userId?hardDelete=<string>
Deletes the user based on the given request (sent to the API as JSON). This permanently deletes all information, metrics, reports and data associated with the user. OR Deletes the user for the given Id. This permanently deletes all information, metrics, reports and data associated with the user. OR Deactivates the user with the given Id.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
hardDelete | string |
Request Body
{"hardDelete"=>"<boolean>", "eventInfo"=>{"deviceDescription"=>"<string>", "deviceName"=>"<string>", "deviceType"=>"<string>", "ipAddress"=>"<string>", "location"=>{"city"=>"<string>", "country"=>"<string>", "latitude"=>"<double>", "longitude"=>"<double>", "region"=>"<string>", "zipcode"=>"<string>", "displayString"=>"<string>"}, "os"=>"<string>", "userAgent"=>"<string>"}}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
X-FusionAuth-TenantId | string | The unique Id of the tenant used to scope this API request. Only required when there is more than one tenant and the API key is not tenant-scoped. | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
""