/signup

Sign Up a User

Supplying the user create request object, this will create a new user.

post

/signup

Authorizations

auth_bearersession_secret

Body

nameany

Pattern: ^\S+$

emailany

Pattern: ^(.+)@(.+)$

primaryPhoneNbany

Pattern: ([\.\+\-\s\/()]*[0-9][\.\+\-\s\/()]*){8,15}

firstNameany

Pattern: ^[A-Za-z0-9 ]{2,20}

lastNameany

Pattern: ^[A-Za-z0-9 ]{3,30}

passwordany

The user's plaintext password, only to be provided in POST/PUT requests in the User Resource REST API interface. In the future, a dedicated REST API model may be constructed instead of using a direct User model.

Pattern: ^\S+$

levelundefined · enum

The user's level to assign. Depending on the usage, the server may ignore this field and assign its own description.

Options: UNPRIVILEGED, USER, SUPERUSER

profilesany

Used in conjunction with the user creation request to specify.

Responses

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'http://localhost:8080/api/rest/signup' \
  --header 'Authorization: YOUR_API_KEY' \
  --header 'Content-Type: */*' \
  --data '{
    "name": null,
    "email": null,
    "primaryPhoneNb": null,
    "firstName": null,
    "lastName": null,
    "password": null,
    "level": "UNPRIVILEGED",
    "profiles": [
      {
        "applicationId": null,
        "displayName": null,
        "imageUrl": null
      }
    ]
  }'

400

401

403

404

409

500

501

503

default

400

{
  "code": "text",
  "message": "text"
}