Skip to content

Registrations

Create

Example request:

{
"data": {
"type": "registration",
"attributes": {
"account": {
"name": "Account Name"
},
"display_settings": {
"language": "en"
},
"identity": {
"email": "[email protected]",
"password": "password"
},
"terms": {
"accepted": true
},
"user": {
"name": "Name"
}
}
}
}

Example response:

{
"data": {
"id": "98815bd8-f3e6-41ec-8c4a-25a431ac6ce4",
"type": "user",
"attributes": {
"email": "[email protected]",
"accounts": [
{
"name": "Account Name",
"user": {
"id": "36683a5a-ae4d-4019-bce2-23a17a63dda0",
"name": "User Name"
}
}
]
}
}
}

This endpoint creates a registration and returns a user. It also dispatches a Bearer token in Header.

HTTP Request

POST /auth/register

Arguments

ParameterDescription
account.nameAccount name
display_settings.languageLanguage to use
identity.emailEmail-Address for authentication
identity.passwordPassword for authentication
terms.acceptedMust be true
user.nameUsername