Users

Authenticate user

Changed on

Validates email/password credentials via bcrypt. Returns a JWT access token in the response body and sets a refresh token in an HTTP-only cookie. Rate-limited to 5 requests per minute per IP.

post/users/login

Request

  • Base URL
    /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/users/login
  • Auth
    none declared

Request body

emailstring email required
passwordstring password required

Example request

{
  "email": "user@example.com",
  "password": "SecurePassword123!"
}

Response

Authentication successful

messagestring

Example response

{
  "message": "Accepted",
  "data": {
    "onboarding_status": "completed"
  }
}

Changes

  • d86d0bf8bebeRevision changes
    • info

      api operation id loginUser was added

    • info

      api tag Users added

    • info

      api tag Authentication removed

  • 655215fe8c81Revision changes
    • info

      api operation id loginUser removed and replaced with

    • info

      api tag Authentication added

    • info

      api tag Users removed