Headscale unofficial
POST/api/v1/user/{oldId}/rename/{newName}

Rename a user

Renames a user by changing the name associated with the specified identifier. Provide oldId as a uint64-formatted string and newName as a string in the path.

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

2 parameters
oldIdstringrequired
The identifier of the user to rename, as a uint64-formatted string.
newNamestringrequired
The new name for the user.

2 status codes
200Returns an object containing the renamed `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 oldId path parameter must be a uint64-formatted string, and newName must be a string. The oldId identifies the user to rename.