Fuselage
Powered By GitBook
Register Users
URL
Requires Auth
HTTP Method
/api/v1/users.register
no
POST

Payload

Argument
Example
Required
Description
username
rogersmith
Required
The username for the user.
email
Required
The email for the user.
pass
passw0rd
Required
The password for the user.
name
Roger Smith
Required
The name of the user. Can be "" if Require Name For Signup is disabled in Accounts > Registration
secretURL
Jjwjg6gouWLXhMGKW
Optional
String appended to secret registration URL (if using).

Example Call

1
curl -H "Content-type:application/json" \
2
http://localhost:3000/api/v1/users.register \
3
-d '{ "username": "rogersmith", "email": "[email protected]", "pass": "passw0rd", "name": "Roger Smith"}'
Copied!

Example Result

1
{
2
"user": {
3
"_id": "nSYqWzZ4GsKTX4dyK",
4
"type": "user",
5
"status": "offline",
6
"active": true,
7
"name": "Example User",
8
"utcOffset": 0,
9
"username": "example"
10
},
11
"success": true
12
}
Copied!

Change Log

Version
Description
0.50.0
Added
Last modified 6mo ago
Export as PDF
Copy link