Sign in
Auth

Login Feature

Changed on

Log into the Platform

post/auth/login

Request

  • Base URL: http://localhost:8080/api/v1
  • URL: http://localhost:8080/api/v1/auth/login
  • Auth: none declared

Request body

emailstring email required

Email ID of the User/Therapist

passwordstring required

Password of the User/Therapist (meets strong password requirements)

remember_meboolean required

Whether to remember the user for a longer session duration

Example request

{
  "email": "dr.doolittle@zoolittle.com",
  "password": "IlikeMYanimalsLITTLE@34",
  "remember_me": true
}

Response

User logged in successfully.

access_tokenstring required

The JWT Access Token issued for this User

token_typestring required

Describes the type of JWT Token designated to this User

expires_inunknown required
refresh_tokenstring required

Used to get a new access token after the current one expires...

needs_mfaboolean required

Indicates if the user needs multi-factor authentication

errorunknown

Example response

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "bearer",
  "expires_in": 3600,
  "refresh_token": "67z4xav34h37",
  "user": {
    "id": "f20e5948-01ba-4113-b453-db05d8bde3bc"
  }
}

Changes

  • b6e9cc748dc7Revision changes
    • ○

      added the required property to the response with the status

  • 9261faf997eaRevision changes
    • ▲

      added the new required request property

    • ○

      the response property became required for the status

    • ○

      the response property became required for the status

    • ○

      the response property became required for the status

    • ○

      the response property became required for the status

    • ○

      the response property became required for the status