Authentication

Register New User

Changed on

Provide basic information to self-register for an account.

Note: The /register endpoint accepts the parameters in the body of the request. It does not accept them in the URL as a query string, because that isn't as secure. The input parameters should be included as a JSON object (in the body), as shown in the sample code on the right.

post/register

Request

Request body

usernamestring required

name of user that will be used in subsequent calls

passwordstring required

user password. Password must be at least 8 characters, with at least 1 of each alpha, number and special characters.

emailstring email required

Access is granted only after email validation. By registering an account, you acknowledge that we will contact you regarding API mechanics and data updates necessary to maintain service continuity. These notifications are strictly operational, event-driven (averaging less than 1 per month). This processing is governed by our Privacy Policy. Your email address will never be shared or used for promotions. If you would also like notifications regarding API outages and incidents, please subscribe separately via our status page for those alerts.

orgstring nullable

organization name

Example request

{
  "username": "freddo",
  "password": "the_fr0g",
  "email": "freddo@frog.org",
  "org": "freds world"
}

Response

Successful Response

userstring required
okstring required

Example response

{
  "ok": "User created",
  "user": "freddo"
}

Changes

    • breaking

      added required request body

    • warning

      deleted the query request parameter email

    • warning

      deleted the query request parameter org

    • warning

      deleted the query request parameter password

    • warning

      deleted the query request parameter username

    • info

      query request parameter org list-of-types was widened by adding types null

    • info

      for the query request parameter org, the type was generalized from string to no type

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status