Skip to main content

Sign-in with username and password

Signing in using the username and password

HTTP Request

POST/api/users/auth/pwd/signin

Authorization

Authorization

  • Required: No
  • Permission: None
  • Authentication: None

Request Body

FieldTypeRequiredDescription
usernameStringYesUser provided username
passwordStringYesUser provided password

Example Requests

1import requests
2
3api = requests.Session()
4response = api.post(
5  'http://www.example.com/api/users/auth/pwd/signin/',
6  json={
7      "username": "johndoe",
8      "password": "password123"
9  }
10)

Response Fields

FieldTypeDescription
tokenStringAuthentication token for the user

Example Response

{
"token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9..."
}

Notes

  • The username and password fields must be provided.
  • The response will contain a token (authentication token) for the user.
  • The token can be used for subsequent authenticated requests by including it in the Authorization header.