Version 3.2 Documentation
 

User.signup - REST API

Lets users sign up themselves with the system.

Input is validated according to configuration from sso.conf. All callback services are executed if the user has been created successfully.

On output, confirmation token is returned that may be used to let a user know via email that their account has been prepared but needs to be confirmed by clicking on a selected link.

  • HTTP method: POST
  • URL path: /zato/sso/user/signup

Request

Name Datatype Optional Notes
username string --- Username to create
password string --- User's password
email string Yes User's email
current_app string --- Name of the application the user is signing up through
app_list list --- A list of applications that the user wants to sign up to (each must exist in sso.conf)

Response

Name Datatype Optional Notes
cid string --- Correlation ID assigned to request
status string --- Overall status code
sub_status list Yes Returned only if status is not "ok", a list of error or warning codes
confirm_token string --- Signup confirmation token; URL-safe and 192-bit strong

Usage

$ curl -XPOST "localhost:17010/zato/sso/user/signup" -d '
{
  "username":"my.username",
  "password":"<password>",
  "email":"my.username@example.com",
  "current_app":"CRM",
  "app_list":["CRM"]
}'


{
  "cid": "259529171ff77ce4c8b26e11",
  "status": "ok",
  "confirm_token": "<token>"
}