Reset Password

POST 
/auth/v1/reset

Reset the password of a user, requires email or phone and corresponding verification code.

• Refer to the API, Get SMS or Email Verification Code

Request

Query Parameters

client_id string

Client ID corresponding to the application, can be obtained from Cloud Development Platform -> Identity Authentication -> Development Settings. Defaults to environment ID, can be omitted

Header Parameters

x-device-id string

Device ID, the ID of the current logged-in device. The client should generate it randomly and cache it on the client. This parameter is related to the number of logged-in accounts.

application/json

Body

email string

Use email for verification

phone_number string

Use phone number for verification

new_password string

New Password

verification_token string

SMS or email verification code

Responses

200

A successful response.

Response Headers

application/json

Schema

Schema

any

400

• email and phone number cannot be set at the same time, email or phone number cannot be empty
• verification required, phone number or email verification code is empty
• phone or email does not match validation code, phone number or email does not match the verification code

Response Headers

application/json

Schema

Schema

error Error message (string)
error_code int32
error_description Error description (string)

Example (from schema)

{
  "error": "string",
  "error_code": 0,
  "error_description": "string"
}

Example

{
  "error": "invalid_argument",
  "error_code": 3,
  "error_description": "email or phone number is empty"
}

403

Response Headers

application/json

Schema

Schema

object

Example (from schema)

{}

Example

{
  "error": "permission_denied",
  "error_code": 7,
  "error_description": "cors permission denied, please check if lowcode-5g9ac20u2a27da47-1307578329.tcloudbaseapp.com in your client AOJ8yAABzNsMXf0IcKc domains"
}

500

An unexpected error response.

Response Headers

application/json

Schema

Schema

error Error message (string)
error_code int32
error_description Error description (string)

Example (from schema)

{
  "error": "string",
  "error_code": 0,
  "error_description": "string"
}

Loading...