githubEdit

post__user_login

POST /user/login

User Login

Authenticate user with email and password.

This endpoint validates user credentials and returns JWT tokens for API access. The system checks:

  • Email exists and is active

  • Password matches stored hash

  • Account is not deleted or banned

Authentication Flow:

  1. Submit email and password

  2. System validates credentials

  3. Returns JWT access token and refresh token

  4. Use access token in Authorization header for API calls

  5. Use refresh token to get new access token when expired

Token Expiration:

  • Access tokens expire after 1 hour

  • Refresh tokens have longer expiration

  • Use /user/refresh to renew access tokens

TypeScript Client Library

Code Samples

Body parameter

Parameters

Name
In
Type
Required
Description

body

body

object

true

none

» email

body

string(email)

true

User's email address

» password

body

string

true

User's password

Example responses

200 Response

Responses

Status
Meaning
Description
Schema

200

Login successful

Inline

401

Authentication failed

Inline

Response Schema

Status Code 200

Name
Type
Required
Restrictions
Description

» success

boolean

false

none

none

» accessToken

string

false

none

JWT access token for API authentication

» refreshToken

string

false

none

JWT refresh token for token renewal

» tokenId

string

false

none

Internal token identifier

» expiresAt

integer

false

none

Access token expiration timestamp

» user

object

false

none

none

»» id

string

false

none

User's unique identifier

»» email

string

false

none

User's email address

»» name

string

false

none

User's display name

»» orgId

string

false

none

Organization identifier

Status Code 401

Name
Type
Required
Restrictions
Description

» success

boolean

false

none

none

» error_code

string

false

none

Specific authentication error

Enumerated Values

Property
Value

error_code

USER_NOT_FOUND

error_code

INVALID_PASSWORD

error_code

USER_INACTIVE

error_code

NO_PASSWORD_SET

To perform this operation, you must be authenticated by means of one of the following methods: BearerAuth

Last updated

Was this helpful?