NoxVR Documentation
Authentication

User registration

Register a new user account. If successful, the user will be automatically logged in and a session cookie will be set. Registration may be disabled on some servers.

POST
/auth/register
usernamestring

Username (unique identifier)

Match^[a-z0-9_.-]{3,16}$
passwordstring

User password

Length6 <= length <= 128
emailstring

User's email address

Formatemail
Lengthlength <= 320
display?string

Display name (optional, defaults to username)

Match^.{3,32}$

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://nox.hactazia.fr/api/auth/register" \  -H "Content-Type: application/json" \  -d '{    "username": "string",    "password": "string",    "email": "user@example.com"  }'
{
  "data": {
    "token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
    "expires": 1750945093437,
    "created_at": 1750936113726,
    "user": {
      "id": 123,
      "username": "hactazia",
      "display": "Hactazia",
      "server": "hactazia.fr",
      "tags": [
        "sys:admin",
        "dft:can_file_upload",
        "dft:can_self_edit",
        "dft:can_world_create",
        "sys:unverified"
      ],
      "bio": "Game developer and VR enthusiast",
      "thumbnail": "https://avr.hactazia.fr/api/users/123/thumbnail",
      "banner": "https://avr.hactazia.fr/api/users/123/banner",
      "links": [
        "https://avr.hactazia.fr/"
      ],
      "rank": 0,
      "relations": null,
      "email": "hactazia@example.com",
      "email_verified": false,
      "created_at": 1750936113726,
      "home": "world123@hactazia.fr",
      "twofa_enabled": false
    }
  },
  "request": "/api/",
  "time": 1750945093437
}
{
  "error": {
    "message": "Invalid field: {0}, {1}.",
    "code": 5,
    "status": 400
  },
  "data": null
}
{
  "error": {
    "message": "This service is disabled.",
    "code": 10,
    "status": 403
  }
}
{
  "error": {
    "message": "{0} already exists with {1}.",
    "code": 6,
    "status": 409
  },
  "data": null
}