POST `/auth/forgot-password`

When a user forgets their password, send a password reset verification code via email or SMS. Supports email and SMS methods. Reference: NIST SP 800-63B §5.1.1.2, OWASP ASVS V2.1.

Authentication None application/json

Request Body

Schema: dto.ForgotPasswordRequest

Field	Type	Required	Example	Constraints	Description
`identity`	`string`	Yes			Email or phone

Responses

Status	Description	Schema
200	Verification code sent to associated email or phone	`dto.ForgotPasswordResponse`
400	Invalid request parameters or user does not exist	`gitee_com_linmes_authms_base_dto.SimpleResponse`
500	Internal server error	`gitee_com_linmes_authms_base_dto.SimpleResponse`

Referenced Schemas

dto.ForgotPasswordResponse

Forgot password response

Field	Type	Required	Example	Constraints	Description
`expires_in`	`integer`	No			Expiration time
`message`	`string`	No			Message

gitee_com_linmes_authms_base_dto.SimpleResponse

Field	Type	Required
`code`	`integer`	No
`message`	`string`	No
`timestamp`	`string`	No

Try this API in Scalar → Download OpenAPI spec (JSON) ↓

POST /auth/forgot-password