Sign Up

curl --request POST \
  --url https://api.example.com/api/sign-up/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "<string>",
  "email": "<string>",
  "password": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "number_phone": "<string>"
}
'

import requests

url = "https://api.example.com/api/sign-up/"

payload = {
    "username": "<string>",
    "email": "<string>",
    "password": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "number_phone": "<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({
    username: '<string>',
    email: '<string>',
    password: '<string>',
    first_name: '<string>',
    last_name: '<string>',
    number_phone: '<string>'
  })
};

fetch('https://api.example.com/api/sign-up/', 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/sign-up/",
  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([
    'username' => '<string>',
    'email' => '<string>',
    'password' => '<string>',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'number_phone' => '<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/sign-up/"

	payload := strings.NewReader("{\n  \"username\": \"<string>\",\n  \"email\": \"<string>\",\n  \"password\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"number_phone\": \"<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/sign-up/")
  .header("Content-Type", "application/json")
  .body("{\n  \"username\": \"<string>\",\n  \"email\": \"<string>\",\n  \"password\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"number_phone\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/sign-up/")

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  \"username\": \"<string>\",\n  \"email\": \"<string>\",\n  \"password\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"number_phone\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "access": "<string>",
  "refresh": "<string>",
  "user": {
    "user.id": 123,
    "user.username": "<string>",
    "user.email": "<string>",
    "user.first_name": "<string>",
    "user.last_name": "<string>",
    "user.number_phone": "<string>",
    "user.avatar": "<string>"
  }
}

POST

api

sign-up

curl --request POST \
  --url https://api.example.com/api/sign-up/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "<string>",
  "email": "<string>",
  "password": "<string>",
  "first_name": "<string>",
  "last_name": "<string>",
  "number_phone": "<string>"
}
'

import requests

url = "https://api.example.com/api/sign-up/"

payload = {
    "username": "<string>",
    "email": "<string>",
    "password": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "number_phone": "<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({
    username: '<string>',
    email: '<string>',
    password: '<string>',
    first_name: '<string>',
    last_name: '<string>',
    number_phone: '<string>'
  })
};

fetch('https://api.example.com/api/sign-up/', 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/sign-up/",
  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([
    'username' => '<string>',
    'email' => '<string>',
    'password' => '<string>',
    'first_name' => '<string>',
    'last_name' => '<string>',
    'number_phone' => '<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/sign-up/"

	payload := strings.NewReader("{\n  \"username\": \"<string>\",\n  \"email\": \"<string>\",\n  \"password\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"number_phone\": \"<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/sign-up/")
  .header("Content-Type", "application/json")
  .body("{\n  \"username\": \"<string>\",\n  \"email\": \"<string>\",\n  \"password\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"number_phone\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/sign-up/")

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  \"username\": \"<string>\",\n  \"email\": \"<string>\",\n  \"password\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"number_phone\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "access": "<string>",
  "refresh": "<string>",
  "user": {
    "user.id": 123,
    "user.username": "<string>",
    "user.email": "<string>",
    "user.first_name": "<string>",
    "user.last_name": "<string>",
    "user.number_phone": "<string>",
    "user.avatar": "<string>"
  }
}

Overview

The sign-up endpoint creates a new user account in the Password Generator application. Upon successful registration, the endpoint returns JWT access and refresh tokens along with the user’s information.

Endpoint

POST /api/sign-up/

Request Body

string

required

Unique username for the account. This field is required by Django’s AbstractUser model.

string

required

User’s email address. Must be unique in the system.

string

required

User’s password. Will be securely hashed using Django’s password hashing system.

string

User’s first name. Defaults to empty string if not provided.

string

User’s last name. Defaults to empty string if not provided.

string

User’s phone number. Maximum 10 characters. Can be null.

Response

string

JWT access token used for authenticating API requests. Short-lived token.

string

JWT refresh token used to obtain new access tokens when they expire.

object

User object containing the created user’s information.

integer

Unique identifier for the user.

string

User’s username.

string

User’s email address.

string

User’s first name.

string

User’s last name.

string

User’s phone number.

string

URL to user’s avatar image (if uploaded).

Example Request

cURL

curl -X POST http://localhost:8000/api/sign-up/ \
  -H "Content-Type: application/json" \
  -d '{
    "username": "johndoe",
    "email": "[email protected]",
    "password": "SecurePass123!",
    "first_name": "John",
    "last_name": "Doe",
    "number_phone": "5551234567"
  }'

Python

import requests

url = "http://localhost:8000/api/sign-up/"
payload = {
    "username": "johndoe",
    "email": "[email protected]",
    "password": "SecurePass123!",
    "first_name": "John",
    "last_name": "Doe",
    "number_phone": "5551234567"
}

response = requests.post(url, json=payload)
data = response.json()

JavaScript

fetch('http://localhost:8000/api/sign-up/', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    username: 'johndoe',
    email: '[email protected]',
    password: 'SecurePass123!',
    first_name: 'John',
    last_name: 'Doe',
    number_phone: '5551234567'
  })
})
.then(response => response.json())
.then(data => console.log(data));

Example Response

201 Created

{
  "refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  "access": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  "user": {
    "id": 1,
    "username": "johndoe",
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Doe",
    "number_phone": "5551234567",
    "avatar": null
  }
}

Error Responses

400 Bad Request - Missing Fields

{
  "error": "Missing required fields."
}

400 Bad Request - Validation Error

{
  "username": ["This field is required."],
  "email": ["user with this email already exists."]
}

500 Internal Server Error

{
  "error": "Error message details"
}

Implementation Details

The sign-up endpoint is implemented in apps/users/views.py:49-79. Here’s how it works:

Validation: The request data is validated against the UsersSerializer
User Creation: If valid, a new user is created with the provided data
Password Hashing: The password is securely hashed using user.set_password()
Token Generation: JWT tokens are generated using RefreshToken.for_user(user)
Response: Returns both tokens and the complete user object

Code Reference

From apps/users/views.py:49-79:

@api_view(['POST'])
@permission_classes([AllowAny])
def sign_up(request):
    try:
        serializer = UsersSerializer(data=request.data)

        if serializer.is_valid():
            serializer.save()

            user = Users.objects.get(username=serializer.data['username'])
            user.email = serializer.data['email']
            user.set_password(serializer.data['password'])
            user.first_name = serializer.data['first_name']
            user.last_name = serializer.data['last_name']
            user.number_phone = serializer.data['number_phone']
            user.save()

            refresh = RefreshToken.for_user(user)

            return Response({
                'refresh': str(refresh),
                'access': str(refresh.access_token),
                'user': serializer.data
            }, status=status.HTTP_201_CREATED)

        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

    except KeyError:
        return Response({'error': 'Missing required fields.'}, status=status.HTTP_400_BAD_REQUEST)
    except Exception as e:
        return Response({'error': str(e)}, status=status.HTTP_500_INTERNAL_SERVER_ERROR)

Notes

This endpoint does not require authentication (@permission_classes([AllowAny]))
The password is automatically hashed and never stored in plain text
Both access and refresh tokens are returned immediately upon successful registration
The user model extends Django’s AbstractUser (defined in apps/users/models.py:5)

⌘I

Authentication

Password Generation

Saved Passwords

User Management

Overview

Endpoint

Request Body

Response

Example Request

Example Response

Error Responses

Implementation Details

Code Reference

Notes

​Overview

​Endpoint

​Request Body

​Response

​Example Request

​Example Response

​Error Responses

​Implementation Details

​Code Reference

​Notes

Overview

Endpoint

Request Body

Response

Example Request

Example Response

Error Responses

Implementation Details

Code Reference

Notes