Sign in
Authentication

Login

Changed on

Login with username and password and receive a session token.

post/auth/login

Request

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

Request body

emailstring email required

User email

passwordstring required

User password

Example request

{
  "email": "testuser@email.com",
  "password": "password"
}

Response

accessTokenstring required

Access token

isAdminboolean required

Is admin user

isOnboardedboolean required

Is onboarded

namestring required

User name

profileImagePathstring required

Profile image path

shouldChangePasswordboolean required

Should change password

userEmailstring email required

User email

userIdstring uuid required

User ID

Changes

  • 2cd7bd44a940Revision changes
    • info

      the response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ was added for the status