Recover Password

Recover Password
Initiate user password recovery

This endpoint initiates the password recovery process. A reset link will be sent to the provided email address if it is registered in the system. This endpoint does not require authentication and can be accessed publicly.

Request
URI
POST
https://{api_host}/provider/users/password?action=recover&email=user-email
COPY
Query Parameters
action
Required
Constraints: default: recover

Action to initiate password recovery. The only allowed value is 'recover'.

Possible values are : recover,
string
email
Required

The email address of the user whose password is to be recovered. It must be registered in the system.

Header Parameters
string
Accept
Required

Accept

Possible values are : application/vnd.vmware.dms-v1+json,
Authentication
This operation uses the following authentication methods.
Responses
200

The password recovery process has been initiated. If the user is registered in the system, a reset link will be sent via email.

Operation doesn't return any data structure

400

Bad request.

Returns ErrorDto of type(s) application/vnd.vmware.dms-v1+json 
{
    "message": "string",
    "errorCodes": {
        "type": "string"
    }
}
string
message
Optional

message

object
errorCodes
Optional

errorCodes


503

Mail server is not configured or is unavailable

Returns ErrorDto of type(s) application/vnd.vmware.dms-v1+json 
"ErrorDto Object"
string
message
Optional

message

object
errorCodes
Optional

errorCodes


Code Samples
COPY
                    curl -X POST  https://{api_host}/provider/users/password?action=recover&email=<user-email>
On This Page
Users Operations
GET
Get All Users
POST
Create User
DELETE
Delete User By Email
GET
Get User
POST
Change Password
POST
Recover Password