Login
The first step of the login process, where a user enters their email.
less than a minute
Login
Title: Login
| Type | object |
| Required | No |
| Additional properties | Not allowed |
Description: The first step of the login process, where a user enters their email.
Example:
{
"error": "Invalid credentials",
"message": "Logout successful"
}
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - error | No | string | No | - | Error |
| - message | No | string | No | - | Message |
1. Property Login > error
Title: Error
| Type | string |
| Required | No |
Description: Human-readable message to be displayed about an error that occurred
Example:
"Invalid credentials"
2. Property Login > message
Title: Message
| Type | string |
| Required | No |
Description: Human-readable message to display to the user. It being present is not indicative of an error
Example:
"Logout successful"