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

NameDatatypeOptionalNotes
usernamestring---Username to create
passwordstring---User's password
emailstringYesUser's email
current_appstring---Name of the application the user is signing up through
app_listlist---A list of applications that the user wants to sign up to (each must exist in sso.conf)

Response

NameDatatypeOptionalNotes
cidstring---Correlation ID assigned to request
statusstring---Overall status code
sub_statuslistYesReturned only if status is not "ok", a list of error or warning codes
confirm_tokenstring---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>"
}