Skip to main content

auth.login

post/v1/auth/login

auth.login

Request​

Body

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "format": "email"
          },
          "password": {
            "type": "string"
          },
          "remember": {
            "type": [
              "boolean",
              "null"
            ],
            "description": "Optional remember flag for session lifetime"
          }
        },
        "required": [
          "email",
          "password"
        ],
        "title": "LoginRequest"
      }
    }
  }
}

Responses

200No description
Schema Structure
{
  "type": "object"
}
422Validation error
Schema Structure
{
  "type": "object",
  "properties": {
    "message": {
      "type": "string",
      "description": "Errors overview."
    },
    "errors": {
      "type": "object",
      "description": "A detailed description of each field that failed validation.",
      "additionalProperties": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    }
  },
  "required": [
    "message",
    "errors"
  ]
}