Skip to content
OTA-Pulse Docs

Login

POST
/api/auth/login
 
curl --request POST \
  --url https://example.com/api/auth/login \
  --header 'Content-Type: application/json' \
  --data '{ "email": "hello@example.com", "password": "example" }'

Login with email and password

Request Bodyrequired

Section titled “ Request Bodyrequired ”
Media type application/json
LoginRequest

Login request.

Uses LaxEmail instead of EmailStr so that the seeded admin account (admin@socmon.local) is accepted on the LAN. email_validator >= 2.x refuses .local addresses (RFC 2606 reserved) when check_deliverability=True.

object
email
required
Email
string format: email
password
required
Password
string
>= 8 characters
Example generated 
{
  "email": "hello@example.com",
  "password": "example"
}

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Successful Response

Media type application/json
Token

JWT token response

object
access_token
required
Access Token
string
expires_in
required
Expires In
integer
refresh_token
required
Refresh Token
string
token_type
Token Type
string
default: bearer
user
required
UserResponse

User response schema

object
created_at
required
Created At
string format: date-time
current_terms_version
Current Terms Version
string
""
email
required
Email
string format: email
full_name
required
Any of:
string
id
required
Id
string format: uuid
is_active
required
Is Active
boolean
is_superuser
Is Superuser
boolean
is_verified
required
Is Verified
boolean
last_login
required
Any of:
string format: date-time
organization_id
Any of:
string format: uuid
terms_acceptance_required
Terms Acceptance Required
boolean
terms_accepted_at
Any of:
string format: date-time
terms_version
Any of:
string
timezone
Any of:
string
username
required
Username
string
Example 
{
  "token_type": "bearer",
  "user": {
    "current_terms_version": "",
    "is_superuser": false,
    "terms_acceptance_required": false,
    "timezone": "UTC"
  }
}

422

Section titled “ 422 ”

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Example generated 
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}