Delete a team member
Deletes the member's account. For somebody who has not accepted yet, this cancels the invitation and its link stops working. The company's last owner and its only user cannot be removed. You need to be an owner or hold the deleteUsers permission.
Path parameters
The id of a user. Digits only; anything else answers 404. At least 1.
Returns
200 The member who was removed.
Fields of the 200 answer
A person with a Control Panel account. Ids are sent as strings.
Fields
The user's company, as GET /companies answers it. Null when the account belongs to no company.
The id of the user's company, as a string of digits. An empty string when the account belongs to no company.
The address the person is shown with. For somebody invited who has not accepted, the address they were invited at.
The user's id, as a string of digits.
The person's roles.
Fields of each item
The keys of the permissions the role grants, such as viewWebsites.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | forbidden | The person is not allowed to do this. |
403 | last_owner | The organisation must keep at least one owner. Make someone else an owner first. |
403 | only_user | This is the only user in the organisation. Add another user first. |
403 | privileged_target | That person's account can be changed only by Corefinity. Contact support. |
403 | scope_required | Use a token with the scope named in scope. |
404 | none | Check the id. You see only what your account can reach. |
429 | rate_limited | Wait for the seconds in Retry-After. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl -X DELETE https://manage.corefinity.com/api/user/2042/delete \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json"use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->delete('https://manage.corefinity.com/api/user/2042/delete');
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/user/2042/delete', {
method: 'DELETE',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
},
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.delete(
"https://manage.corefinity.com/api/user/2042/delete",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
)
data = res.json() if res.content else None{
"data": {
"company_id": "1204",
"email": "[email protected]",
"id": "2042",
"mobile": null,
"name": "Tom Harbour",
"role": [
{
"name": "Member (Full Access)",
"permissions": [
"viewWebsites",
"viewDeployments",
"viewTickets",
"createTickets"
],
"slug": "client-member-full"
}
]
},
"message": "User has been deleted successfully",
"status": "success"
}{
"message": "Unauthenticated."
}{
"code": "forbidden",
"message": "You are not allowed to delete users.",
"reason": "forbidden",
"status": "error"
}{
"message": "Not found."
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}Try it is off for this endpointIt deletes data that cannot be brought back. Copy the request and run it yourself when you are sure.