Page tree




In This Document 


Was this document useful? 
Your Rating:
Results:
1 Star2 Star3 Star4 Star5 Star
2 rates


Have a suggestion for the Armor Knowledge Base? Send a message to kb@armor.com.



Overview

This API call applies to both Armor Complete and Armor Anywhere users.

The Reset Password API call redeems a password reset grant, and then resets a user's password. 


Sample request

POST https://api.armor.com/reset

{
   "grantID": "E76566E3C1FE47A99F89A343EF32352D",
   "newPassword": "pass1234"
}

Input

The following table describes the different parts of this API call: 

API Call / URLMethod / Type
/reset POST

The following table describes the parameter (or parameters) for this API call:

ParameterDescriptionFormatRequired or optionalExample
grantIDThe grantID received from the recovery workflow as documented in the recovery section.StringRequired
E76566E3C1FE47A99F89A343EF32352D
newPasswordThe new password for the user, assuming the grant is accepted.StringRequiredpass1234



Sample return 

The following table describes the expected results for specific outputs that may not be clear enough within the sample output.

StatusResponse
200
{
 "success": true
}
403
Bad Request
{}