Delete User API

Permanently delete a user account and all associated data by user ID

Admin

Delete User API

Permanently remove a user account from the system. This action deletes the user and all associated data including profile, devices, and sessions.

Remove Account

Permanently delete user.

Data Cleanup

All user data removed.

Admin Only

Requires admin access.


Endpoint Overview

MUTATION/graphql

Delete a user account by their unique ID. This permanently removes the user and all associated data from the system.

Authentication:Bearer Token
Required scopes:admin

Request Parameters

idInt!Required

The unique identifier of the user to delete.


GraphQL Mutation

mutation deleteUser($id: Int!) {
  deleteUser(id: $id) {
    success
    message
  }
}

Variables:

{
  "id": 12345
}

HTTP Request:

curl -X POST https://api.orbnet.com/graphql \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_ADMIN_TOKEN" \
  -d '{
    "query": "mutation deleteUser($id: Int!) { deleteUser(id: $id) { success message } }",
    "variables": {
      "id": 12345
    }
  }'

Response

200User Deleted Successfully
{
  "data": {
    "deleteUser": {
      "success": true,
      "message": "User deleted successfully"
    }
  }
}
400User Not Found
{
  "errors": [
    {
      "message": "User with ID 12345 not found",
      "path": ["deleteUser"],
      "extensions": {
        "code": "NOT_FOUND"
      }
    }
  ],
  "data": null
}

What Gets Deleted

Account

User credentials and login access.

Profile

All personal information.

Devices

All registered device records.

Sessions

Active connections terminated.


When to Delete

User Request

User requests account deletion.

Terms Violation

User violated service terms.

Fraud Detection

Account identified as fraudulent.

Cleanup

Remove test or inactive accounts.


Best Practices

Verify First

Confirm deletion is intended.

Backup Data

Export user data if needed.

Document Reason

Record why user was deleted.

Notify User

Send deletion confirmation.



Irreversible Action

User deletion is permanent. All account data including profile, subscription, devices, and session history will be permanently removed and cannot be recovered.

Need to Delete Multiple Users?

Use the Delete Bundle Users endpoint for bulk deletion.

Delete Multiple Users