users
Create User
POST
/
api
/
users
/
Create User
curl --request POST \
--url https://api.example.com/api/users/ \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"password": "<string>",
"username": "<string>",
"full_name": "<string>",
"avatar_url": "<string>",
"github_id": "<string>",
"github_login": "<string>",
"github_access_token": "<string>",
"google_id": "<string>",
"google_access_token": "<string>",
"microsoft_id": "<string>",
"microsoft_access_token": "<string>",
"linkedin_id": "<string>",
"linkedin_access_token": "<string>"
}
'import requests
url = "https://api.example.com/api/users/"
payload = {
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"password": "<string>",
"username": "<string>",
"full_name": "<string>",
"avatar_url": "<string>",
"github_id": "<string>",
"github_login": "<string>",
"github_access_token": "<string>",
"google_id": "<string>",
"google_access_token": "<string>",
"microsoft_id": "<string>",
"microsoft_access_token": "<string>",
"linkedin_id": "<string>",
"linkedin_access_token": "<string>"
}
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({
first_name: '<string>',
last_name: '<string>',
email: 'jsmith@example.com',
password: '<string>',
username: '<string>',
full_name: '<string>',
avatar_url: '<string>',
github_id: '<string>',
github_login: '<string>',
github_access_token: '<string>',
google_id: '<string>',
google_access_token: '<string>',
microsoft_id: '<string>',
microsoft_access_token: '<string>',
linkedin_id: '<string>',
linkedin_access_token: '<string>'
})
};
fetch('https://api.example.com/api/users/', 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/api/users/",
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([
'first_name' => '<string>',
'last_name' => '<string>',
'email' => 'jsmith@example.com',
'password' => '<string>',
'username' => '<string>',
'full_name' => '<string>',
'avatar_url' => '<string>',
'github_id' => '<string>',
'github_login' => '<string>',
'github_access_token' => '<string>',
'google_id' => '<string>',
'google_access_token' => '<string>',
'microsoft_id' => '<string>',
'microsoft_access_token' => '<string>',
'linkedin_id' => '<string>',
'linkedin_access_token' => '<string>'
]),
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/api/users/"
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"username\": \"<string>\",\n \"full_name\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"github_id\": \"<string>\",\n \"github_login\": \"<string>\",\n \"github_access_token\": \"<string>\",\n \"google_id\": \"<string>\",\n \"google_access_token\": \"<string>\",\n \"microsoft_id\": \"<string>\",\n \"microsoft_access_token\": \"<string>\",\n \"linkedin_id\": \"<string>\",\n \"linkedin_access_token\": \"<string>\"\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/api/users/")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"username\": \"<string>\",\n \"full_name\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"github_id\": \"<string>\",\n \"github_login\": \"<string>\",\n \"github_access_token\": \"<string>\",\n \"google_id\": \"<string>\",\n \"google_access_token\": \"<string>\",\n \"microsoft_id\": \"<string>\",\n \"microsoft_access_token\": \"<string>\",\n \"linkedin_id\": \"<string>\",\n \"linkedin_access_token\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/users/")
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 \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"username\": \"<string>\",\n \"full_name\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"github_id\": \"<string>\",\n \"github_login\": \"<string>\",\n \"github_access_token\": \"<string>\",\n \"google_id\": \"<string>\",\n \"google_access_token\": \"<string>\",\n \"microsoft_id\": \"<string>\",\n \"microsoft_access_token\": \"<string>\",\n \"linkedin_id\": \"<string>\",\n \"linkedin_access_token\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"user_id": 123,
"role": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"username": "<string>",
"full_name": "<string>",
"avatar_url": "<string>",
"plan": "<string>",
"stripe_customer_id": "<string>",
"mfa_enabled": false,
"onboarding_completed": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Body
application/json
Schema for creating a new User inherits from UserBase, can add extra fields if needed.
Response
Successful Response
Schema for reading a User (e.g GET requests). inculdes DB-generated fields like IDs, timestamps, etc.
⌘I
Create User
curl --request POST \
--url https://api.example.com/api/users/ \
--header 'Content-Type: application/json' \
--data '
{
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"password": "<string>",
"username": "<string>",
"full_name": "<string>",
"avatar_url": "<string>",
"github_id": "<string>",
"github_login": "<string>",
"github_access_token": "<string>",
"google_id": "<string>",
"google_access_token": "<string>",
"microsoft_id": "<string>",
"microsoft_access_token": "<string>",
"linkedin_id": "<string>",
"linkedin_access_token": "<string>"
}
'import requests
url = "https://api.example.com/api/users/"
payload = {
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"password": "<string>",
"username": "<string>",
"full_name": "<string>",
"avatar_url": "<string>",
"github_id": "<string>",
"github_login": "<string>",
"github_access_token": "<string>",
"google_id": "<string>",
"google_access_token": "<string>",
"microsoft_id": "<string>",
"microsoft_access_token": "<string>",
"linkedin_id": "<string>",
"linkedin_access_token": "<string>"
}
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({
first_name: '<string>',
last_name: '<string>',
email: 'jsmith@example.com',
password: '<string>',
username: '<string>',
full_name: '<string>',
avatar_url: '<string>',
github_id: '<string>',
github_login: '<string>',
github_access_token: '<string>',
google_id: '<string>',
google_access_token: '<string>',
microsoft_id: '<string>',
microsoft_access_token: '<string>',
linkedin_id: '<string>',
linkedin_access_token: '<string>'
})
};
fetch('https://api.example.com/api/users/', 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/api/users/",
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([
'first_name' => '<string>',
'last_name' => '<string>',
'email' => 'jsmith@example.com',
'password' => '<string>',
'username' => '<string>',
'full_name' => '<string>',
'avatar_url' => '<string>',
'github_id' => '<string>',
'github_login' => '<string>',
'github_access_token' => '<string>',
'google_id' => '<string>',
'google_access_token' => '<string>',
'microsoft_id' => '<string>',
'microsoft_access_token' => '<string>',
'linkedin_id' => '<string>',
'linkedin_access_token' => '<string>'
]),
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/api/users/"
payload := strings.NewReader("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"username\": \"<string>\",\n \"full_name\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"github_id\": \"<string>\",\n \"github_login\": \"<string>\",\n \"github_access_token\": \"<string>\",\n \"google_id\": \"<string>\",\n \"google_access_token\": \"<string>\",\n \"microsoft_id\": \"<string>\",\n \"microsoft_access_token\": \"<string>\",\n \"linkedin_id\": \"<string>\",\n \"linkedin_access_token\": \"<string>\"\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/api/users/")
.header("Content-Type", "application/json")
.body("{\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"username\": \"<string>\",\n \"full_name\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"github_id\": \"<string>\",\n \"github_login\": \"<string>\",\n \"github_access_token\": \"<string>\",\n \"google_id\": \"<string>\",\n \"google_access_token\": \"<string>\",\n \"microsoft_id\": \"<string>\",\n \"microsoft_access_token\": \"<string>\",\n \"linkedin_id\": \"<string>\",\n \"linkedin_access_token\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/users/")
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 \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"password\": \"<string>\",\n \"username\": \"<string>\",\n \"full_name\": \"<string>\",\n \"avatar_url\": \"<string>\",\n \"github_id\": \"<string>\",\n \"github_login\": \"<string>\",\n \"github_access_token\": \"<string>\",\n \"google_id\": \"<string>\",\n \"google_access_token\": \"<string>\",\n \"microsoft_id\": \"<string>\",\n \"microsoft_access_token\": \"<string>\",\n \"linkedin_id\": \"<string>\",\n \"linkedin_access_token\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"first_name": "<string>",
"last_name": "<string>",
"email": "jsmith@example.com",
"user_id": 123,
"role": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"username": "<string>",
"full_name": "<string>",
"avatar_url": "<string>",
"plan": "<string>",
"stripe_customer_id": "<string>",
"mfa_enabled": false,
"onboarding_completed": false
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}