Delete a user | Headscale unofficial

1 parameter

idstringrequired

The identifier of the user to delete, as a uint64-formatted string.

2 status codes

200Returns an empty object when the delete operation completes.

defaultReturned when the request fails; includes a problem details object with information about the error.

detailstringoptional

A human-readable explanation specific to this occurrence of the problem.

errorsarray<object>optional

Optional list of individual error details

instancestringoptional

A URI reference that identifies the specific occurrence of the problem.

statusintegeroptional

HTTP status code

titlestringoptional

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

typestringoptional

A URI reference to human-readable documentation for the error.

Default:about:blank

Error handling

The id path parameter must be a uint64-formatted string identifying the user to delete.

import { Client } from "headscale-unofficial-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.user.delete({ id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{}

Request

Response

Errors