SoulFire LogoSoulFire

Create user

Creates a new user account in the system.

POST
/v1/users

Creates a new user account in the system.

Authorization

AuthorizationBearer <token>

Preferred API authentication. Use a JWT with the api audience.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

username*string

The username for the new user. Must be lowercase, between 3 and 32 characters. Must begin with an alphanumeric character, followed by alphanumeric characters or dashes, and end with an alphanumeric character. Must be unique across all users.

role*

The role to assign to the user. Determines what permissions the user has. ADMIN users have all permissions, while USER role has limited permissions controlled by server settings.

email*string

The email address for the user. Must be a valid email format and unique across all users. Maximum length is 255 characters.

Formatemail

Response Body

application/json

application/json

application/json

application/json

curl -X POST "http://127.0.0.1:38765/v1/users" \  -H "Content-Type: application/json" \  -d '{    "username": "",    "role": "ADMIN",    "email": ""  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"}

How is this page?

List users GET

Lists all users in the system.

Get user GET

Retrieves detailed information about a specific user.