When a user forgets a password, you can use the API to send the user an email with links to change the password. The email is sent to the email address in the element userName.

Prerequisites
■

You have signed up and registered for Virtual Private Cloud OnDemand and received an email with a user name and password for an Account Administrator.

■

Using the URL in the confirmation email, you have logged in to Virtual Private Cloud OnDemand using the Web UI, set your password, and accepted the Terms of Service.

■

You have logged in as an administrator using the /api/iam/login API and received an OAuth token. See Log In and Receive Access Token for information.

Procedure
1

If necessary, issue a request to get the user name for the user who has forgotten a password: 

GET https://vca.vmware.com/api/iam/Users/userId

In the request, include the OAuth token and the Accept header: 

Accept: application/json;version=5.7
Authorization: Bearer OAuth_token

Include the OAuth token in all subsequent API requests as a request header.

The returned response includes elements for the specified users.

2

Issue a request to send a link to reset the user password: 

PUT https://vca.vmware.com/api/iam/Users/userName/password/forgot
Accept: application/json;version=5.7
Authorization: Bearer OAuth_token
Example: Request and Response to Retrieve Forgotten Password

Request Header – Retrieve password 

PUT https://vca.vmware.com/iam/Users/[email protected]/password/forgot
Accept: application/json;version=5.7
Authorization: Bearer eyJhbGciOiJSUzI1NiJ9.eyJqdGkiOiJiN2VjNjUyZi1mZmUzLTRh…

Request body not required.

Response Header 

Status: 202 ACCEPTED
Content-Length: 0
Date: Mon, 19 May 2014 09:38:30 GMT
Server: Apache-Coyote/1.1

Response body not returned.