Headscale unofficial
POST/api/v1/user

Create a user

Creates a user record. You can provide name, displayName, email, and pictureUrl; all defined fields are strings and none is marked as required.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

4 body fields

User details for the new user; all fields are optional.

displayNamestringoptional
The user's display name.
emailstringoptional
The user's email address.
namestringoptional
The user's name.
pictureUrlstringoptional
The URL of the user's profile picture.

2 status codes
200Returns an object containing the created `user`, including its identifier, name, creation time, display name, email, provider details, and profile picture URL.
userobjectrequired
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 request body is required, but none of its fields is marked as required. When supplied, displayName, email, name, and pictureUrl must be strings.