Reset Password: Set Password
Schema for setting a new password during the password reset process.
less than a minute
Reset Password: Set Password
- 1. Property
Reset Password: Set Password > error - 2. Property
Reset Password: Set Password > message - 3. Property
Reset Password: Set Password > reset_token
Title: Reset Password: Set Password
| Type | object |
| Required | No |
| Additional properties | Not allowed |
Description: Schema for setting a new password during the password reset process.
Example:
{
"error": "Invalid credentials",
"message": "Logout successful",
"reset_token": "abc123xyz"
}
| Property | Pattern | Type | Deprecated | Definition | Title/Description |
|---|---|---|---|---|---|
| - error | No | string | No | - | Error |
| - message | No | string | No | - | Message |
| - reset_token | No | string | No | - | Reset Token |
1. Property Reset Password: Set Password > error
Title: Error
| Type | string |
| Required | No |
Description: Human-readable message to be displayed about an error that occurred
Example:
"Invalid credentials"
2. Property Reset Password: Set Password > 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"
3. Property Reset Password: Set Password > reset_token
Title: Reset Token
| Type | string |
| Required | No |
Description: The token used to verify the password reset request
Example:
"abc123xyz"