v1

latestOpenAPI 3.1.02026-07-131034192.8 KB
Authentication

Register New User

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

Query parameters

usernamestring required

name of user that will be used in subsequent calls

Example:freddo

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.

Example:the_frog

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

emailstring email required

valid email address. The email address used to register will only be used for communication regarding API outages and updates. The email address will not be shared or used for any other promotional purpose. For others in your organization who would like these updates, they can subscribe to our Status Page.

Example:freddo@frog.org

valid email address. The email address used to register will only be used for communication regarding API outages and updates. The email address will not be shared or used for any other promotional purpose. For others in your organization who would like these updates, they can subscribe to our Status Page.

orgstring nullable

organization name

Example:freds world

organization name

Response

Successful Response

userstring required
okstring required

Example response

{
  "ok": "User created",
  "user": "freddo"
}
All 10 operations