Skip to content

Latest commit

 

History

History
109 lines (66 loc) · 2.78 KB

PasswordResets.md

File metadata and controls

109 lines (66 loc) · 2.78 KB

OrderCloud.PasswordResets

All URIs are relative to https://api.ordercloud.io/v1

Method HTTP request Description
ResetPasswordByVerificationCode PUT /password/reset/{verificationCode}
SendVerificationCode POST /password/reset

ResetPasswordByVerificationCode

ResetPasswordByVerificationCode(verificationCode, passwordReset)

Example

var OrderCloud = require('OrderCloud');
var defaultClient = OrderCloud.Sdk.default;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new OrderCloud.PasswordResets();

var verificationCode = "verificationCode_example"; // String | Verification code of the password reset.

var passwordReset = new OrderCloud.PasswordReset(); // PasswordReset | 

apiInstance.ResetPasswordByVerificationCode(verificationCode, passwordReset).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
verificationCode String Verification code of the password reset.
passwordReset PasswordReset

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/plain; charset=utf-8
  • Accept: application/json

SendVerificationCode

SendVerificationCode(passwordResetRequest)

Example

var OrderCloud = require('OrderCloud');
var defaultClient = OrderCloud.Sdk.default;

// Configure OAuth2 access token for authorization: oauth2
var oauth2 = defaultClient.authentications['oauth2'];
oauth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new OrderCloud.PasswordResets();

var passwordResetRequest = new OrderCloud.PasswordResetRequest(); // PasswordResetRequest | 

apiInstance.SendVerificationCode(passwordResetRequest).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Parameters

Name Type Description Notes
passwordResetRequest PasswordResetRequest

Return type

null (empty response body)

Authorization

oauth2

HTTP request headers

  • Content-Type: application/json, text/plain; charset=utf-8
  • Accept: application/json