Searching...

Users

Endpoints for managing user accounts including creating, updating, retrieving, and deleting user information.

post /users

Create a new user

Register a new user in the Nebularis platform.

username string required

The desired username for the new user

email string required

The email address for the new user

password string required

The password for the new user

Responses

User created successfully

Response body Headers
id string

The unique identifier for the new user

username string

The username of the new user

email string

The email address of the new user

This response does not contain any headers

Invalid input

Response body Headers

This response is empty

This response does not contain any headers

Request examples

{
  "username": "johndoe",
  "email": "johndoe@example.com",
  "password": "strongpassword123"
}

Response examples

User created successfully

{
  "id": "user_123",
  "username": "johndoe",
  "email": "johndoe@example.com"
}
get /users/{id}

Get user information

Retrieve details of a specific user.

id string required

The unique identifier of the user

Responses

User information retrieved successfully

Response body Headers
id string

The unique identifier for the user

username string

The username of the user

email string

The email address of the user

This response does not contain any headers

User not found

Response body Headers

This response is empty

This response does not contain any headers

Response examples

User information retrieved successfully

{
  "id": "user_123",
  "username": "johndoe",
  "email": "johndoe@example.com"
}
delete /users/{id}

Delete a user

Delete a user account.

id string required

The unique identifier of the user

Responses

User deleted successfully

Response body Headers

This response is empty

This response does not contain any headers

User not found

Response body Headers

This response is empty

This response does not contain any headers

Response examples

patch /users/{id}

Update user information

Update the details of a specific user.

username string required

The new username for the user

email string required

The new email address for the user

id string required

The unique identifier of the user

Responses

User information updated successfully

Response body Headers

This response is empty

This response does not contain any headers

Invalid input

Response body Headers

This response is empty

This response does not contain any headers

User not found

Response body Headers

This response is empty

This response does not contain any headers

Request examples

{
  "username": "newusername",
  "email": "newemail@example.com"
}

Response examples