Authentication
Signup
Creates a new account and returns an access token.
POST
/
auth
/
signup
/
Signup
curl --request POST \
--url https://api.example.com/auth/signup/ \
--header 'Content-Type: application/json' \
--data '
{
"emailAddress": "[email protected]",
"password": "<string>",
"username": "<string>",
"displayName": "<string>",
"rememberMe": false
}
'import requests
url = "https://api.example.com/auth/signup/"
payload = {
"emailAddress": "[email protected]",
"password": "<string>",
"username": "<string>",
"displayName": "<string>",
"rememberMe": False
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
emailAddress: '[email protected]',
password: '<string>',
username: '<string>',
displayName: '<string>',
rememberMe: false
})
};
fetch('https://api.example.com/auth/signup/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/auth/signup/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'emailAddress' => '[email protected]',
'password' => '<string>',
'username' => '<string>',
'displayName' => '<string>',
'rememberMe' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/auth/signup/"
payload := strings.NewReader("{\n \"emailAddress\": \"[email protected]\",\n \"password\": \"<string>\",\n \"username\": \"<string>\",\n \"displayName\": \"<string>\",\n \"rememberMe\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/auth/signup/")
.header("Content-Type", "application/json")
.body("{\n \"emailAddress\": \"[email protected]\",\n \"password\": \"<string>\",\n \"username\": \"<string>\",\n \"displayName\": \"<string>\",\n \"rememberMe\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/auth/signup/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"emailAddress\": \"[email protected]\",\n \"password\": \"<string>\",\n \"username\": \"<string>\",\n \"displayName\": \"<string>\",\n \"rememberMe\": false\n}"
response = http.request(request)
puts response.read_body{
"apiToken": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"issuedAt": "2023-11-07T05:31:56Z",
"username": "<string>"
}{
"message": "<string>",
"name": "<string>",
"resource": "<string>",
"suggestion": "<string>",
"validation": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"params": {}
}
]
}{
"message": "<string>",
"name": "<string>",
"resource": "<string>",
"suggestion": "<string>",
"validation": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"params": {}
}
]
}"<string>""<string>"Body
application/json
Request payload for signup.
Request payload for signup.
Email address of the account.
Required string length:
5 - 254Password of the account.
Required string length:
8 - 128Public account handle, unique across all accounts.
Required string length:
3 - 32Pattern:
^[a-z0-9]+(?:-[a-z0-9]+)*$Optional display name of the account.
Required string length:
2 - 32Whether to remember the device for extended session. Defaults to false.
Response
Response returned after successful authentication (login/signup).
Response returned after successful authentication (login/signup).
The JWT API token for authentication.
Timestamp when the token expires.
Timestamp when the token was issued.
Handle of the authenticated account.
Required string length:
3 - 32Pattern:
^[a-z0-9]+(?:-[a-z0-9]+)*$Signup
curl --request POST \
--url https://api.example.com/auth/signup/ \
--header 'Content-Type: application/json' \
--data '
{
"emailAddress": "[email protected]",
"password": "<string>",
"username": "<string>",
"displayName": "<string>",
"rememberMe": false
}
'import requests
url = "https://api.example.com/auth/signup/"
payload = {
"emailAddress": "[email protected]",
"password": "<string>",
"username": "<string>",
"displayName": "<string>",
"rememberMe": False
}
headers = {"Content-Type": "application/json"}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
emailAddress: '[email protected]',
password: '<string>',
username: '<string>',
displayName: '<string>',
rememberMe: false
})
};
fetch('https://api.example.com/auth/signup/', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/auth/signup/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'emailAddress' => '[email protected]',
'password' => '<string>',
'username' => '<string>',
'displayName' => '<string>',
'rememberMe' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/auth/signup/"
payload := strings.NewReader("{\n \"emailAddress\": \"[email protected]\",\n \"password\": \"<string>\",\n \"username\": \"<string>\",\n \"displayName\": \"<string>\",\n \"rememberMe\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/auth/signup/")
.header("Content-Type", "application/json")
.body("{\n \"emailAddress\": \"[email protected]\",\n \"password\": \"<string>\",\n \"username\": \"<string>\",\n \"displayName\": \"<string>\",\n \"rememberMe\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/auth/signup/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"emailAddress\": \"[email protected]\",\n \"password\": \"<string>\",\n \"username\": \"<string>\",\n \"displayName\": \"<string>\",\n \"rememberMe\": false\n}"
response = http.request(request)
puts response.read_body{
"apiToken": "<string>",
"expiresAt": "2023-11-07T05:31:56Z",
"issuedAt": "2023-11-07T05:31:56Z",
"username": "<string>"
}{
"message": "<string>",
"name": "<string>",
"resource": "<string>",
"suggestion": "<string>",
"validation": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"params": {}
}
]
}{
"message": "<string>",
"name": "<string>",
"resource": "<string>",
"suggestion": "<string>",
"validation": [
{
"code": "<string>",
"field": "<string>",
"message": "<string>",
"params": {}
}
]
}"<string>""<string>"