Register User
- Print
- DarkLight
- PDF
Register User
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/api/v1/users.register
Changelog
| Version | Description |
|---|---|
| 0.50.0 | Added |
Body parameters
object
username
string Required
The username for the user.
Examplerogersmith
pass
string Required
The password for the user.
Examplepassw0rd
name
string Required
The name of the user. The value can be an empty string if Require Name For Signup is disabled in account registration.
ExampleRoger Smith
secretURL
string
String appended to secret registration URL.
ExampleJjwjg6gouWLXhMGKW
Responses
200
OK
Success Example
{
"user": {
"_id": "nSYqWzZ4GsKTX4dyK",
"type": "user",
"status": "offline",
"active": true,
"name": "Example User",
"utcOffset": 0,
"username": "example"
},
"success": true
}object
user
object
_id
string
type
string
status
string
active
boolean
name
string
utcOffset
integer
username
string
success
boolean
Was this article helpful?