/signup

Sign Up a User

post

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

Authorizations

auth_bearersession_secret

Body

nameanyOptionalPattern: ^\S+$

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

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

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

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

passwordanyOptional

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 · enumOptional

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

Possible values:

profilesanyOptional

A list of profiles to assign to this user during creation. The server will attempt to create a profile for each item in this list.

Responses

400Error

application/json

401Error

application/json

403Error

application/json

404Error

application/json

409Error

application/json

500Error

application/json

501Error

application/json

503Error

application/json

default

default response

application/json

post

HTTPcURLJavaScriptPython

POST /api/rest/signup HTTP/1.1
Host: localhost:8080
Authorization: YOUR_API_KEY
Content-Type: */*
Accept: */*
Content-Length: 191

{
  "name": null,
  "email": null,
  "primaryPhoneNb": null,
  "firstName": null,
  "lastName": null,
  "password": null,
  "level": "UNPRIVILEGED",
  "profiles": [
    {
      "applicationId": null,
      "displayName": null,
      "imageUrl": null
    }
  ]
}

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