Skip to main content
POST
/
api
/
sign-in
Sign In
curl --request POST \
  --url https://api.example.com/api/sign-in/ \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "password": "<string>"
}
'
{
  "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>"
  }
}

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/edimez14/password_generator/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

The sign-in endpoint authenticates existing users and returns JWT access and refresh tokens. Users can authenticate using their email and password.

​
Endpoint

POST /api/sign-in/

​
Request Body

​
email
string
required
User’s email address registered in the system.
​
password
string
required
User’s password.

​
Response

​
access
string
JWT access token for authenticating subsequent API requests. This is a short-lived token.
​
refresh
string
JWT refresh token used to obtain new access tokens when they expire.
​
user
object
Complete user object containing authenticated user’s information.
​
user.id
integer
Unique identifier for the user.
​
user.username
string
User’s username.
​
user.email
string
User’s email address.
​
user.first_name
string
User’s first name.
​
user.last_name
string
User’s last name.
​
user.number_phone
string
User’s phone number.
​
user.avatar
string
URL to user’s avatar image (if uploaded).

​
Example Request

cURL
curl -X POST http://localhost:8000/api/sign-in/ \
  -H "Content-Type: application/json" \
  -d '{
    "email": "[email protected]",
    "password": "SecurePass123!"
  }'
Python
import requests

url = "http://localhost:8000/api/sign-in/"
payload = {
    "email": "[email protected]",
    "password": "SecurePass123!"
}

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

# Store tokens for future requests
access_token = data['access']
refresh_token = data['refresh']
JavaScript
fetch('http://localhost:8000/api/sign-in/', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    email: '[email protected]',
    password: 'SecurePass123!'
  })
})
.then(response => response.json())
.then(data => {
  // Store tokens in localStorage or secure storage
  localStorage.setItem('access_token', data.access);
  localStorage.setItem('refresh_token', data.refresh);
});

​
Example Response

200 OK
{
  "refresh": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  "access": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9...",
  "user": {
    "id": 1,
    "username": "johndoe",
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Doe",
    "number_phone": "5551234567",
    "avatar": "/media/avatars/profile.jpg"
  }
}

​
Error Responses

400 Bad Request - Invalid Password
{
  "error": "Invalid password"
}
400 Bad Request - Missing Fields
{
  "error": "Email and password are required."
}
404 Not Found - User Does Not Exist
{
  "error": "User does not exist."
}
500 Internal Server Error
{
  "error": "Error message details"
}

​
Implementation Details

The sign-in endpoint is implemented in apps/users/views.py:21-44. Here’s the authentication flow:
  1. User Lookup: Retrieves user by email using get_object_or_404()
  2. Password Verification: Validates password using Django’s check_password() method
  3. Token Generation: Creates JWT tokens using RefreshToken.for_user(user)
  4. User Serialization: Returns complete user data via UsersSerializer
  5. Response: Returns tokens and user object on success

​
Code Reference

From apps/users/views.py:21-44: 
@api_view(['POST'])
@permission_classes([AllowAny])
def sign_in(request):
    try:
        user = get_object_or_404(Users, email=request.data.get('email'))

        if not user.check_password(request.data.get('password')):
            return Response({'error': 'Invalid password'}, status=status.HTTP_400_BAD_REQUEST)

        refresh = RefreshToken.for_user(user)
        serializer = UsersSerializer(instance=user)

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

    except KeyError:
        return Response({'error': 'Email and password are required.'}, status=status.HTTP_400_BAD_REQUEST)
    except Users.DoesNotExist:
        return Response({'error': 'User does not exist.'}, status=status.HTTP_404_NOT_FOUND)
    except Exception as e:
        return Response({'error': str(e)}, status=status.HTTP_500_INTERNAL_SERVER_ERROR)

​
Using the Access Token

Once you receive the access token, include it in the Authorization header for authenticated requests:
cURL
curl -X GET http://localhost:8000/api/profile/ \
  -H "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."
Python
import requests

headers = {
    "Authorization": f"Bearer {access_token}"
}

response = requests.get("http://localhost:8000/api/profile/", headers=headers)

​
Notes

  • This endpoint does not require authentication (@permission_classes([AllowAny]))
  • Authentication is performed using email (not username)
  • Passwords are never returned in the response
  • The access token has a limited lifetime and should be refreshed using the refresh token
  • Failed login attempts return specific error messages to help identify the issue

Build docs developers (and LLMs) love

Get started for freeTalk to us