Reset a password from the Sign In page

After a client is forced to reset their password by the admin, use this method to start a password reset procedure for the client.

Authorization

bearerAuth

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

action?string

Specify code to indicate that a verification code is required to restore a password.

code?string

The verification code sent to a client email address.

uuid?uuid

The universally unique identifier (UUID) obtained after initializing the Sign In wizard.

Formatuuid

Response Body

`application/json`

curl -X POST "https://example.com/api/v2/my/signin/password/restore" \  -H "Content-Type: application/json" \  -d '{}'

{  "code": 200,  "data": null,  "done": true,  "uuid": "36f59381-5b54-48bd-a0c7-3b908c476732",  "workflow": "reset_password"}

{  "error": {    "message": "Bad Request",    "details": [      {        "issue": "The selected value is invalid.",        "field": "parameter"      }    ]  }}

{  "error": {    "message": "Too Many Requests"  }}

{  "error": {    "message": "Service Unavailable"  }}

Reset a password from the Sign In page

Authorization

Request Body

Response Body

200application/json

400application/json

429application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`