{"id":10122,"date":"2024-06-10T12:37:41","date_gmt":"2024-06-10T12:37:41","guid":{"rendered":"https:\/\/www.purewl.com\/developer\/docs\/api-reference\/api-reference\/vpn-account-management-vam\/change-password\/"},"modified":"2025-02-19T10:25:10","modified_gmt":"2025-02-19T10:25:10","slug":"change-password","status":"publish","type":"docs","link":"https:\/\/www.purewl.com\/developer\/guides\/api\/api-reference\/vpn-account-management-vam\/change-password\/","title":{"rendered":"Change Password"},"content":{"rendered":"\n<p>Changing a VPN account password via API is an essential feature for maintaining account security and ensuring that users can update their credentials as needed. This functionality allows administrators or users to programmatically update the password of a VPN account, which is critical for managing access and protecting sensitive information. This article provides a technical overview of how to implement password changes through API calls.<\/p>\n\n\n\n<h2 class=\"wp-block-heading\">Change Password<\/h2>\n\n\n\n<p>Use this API to change password of a VPN Account.<\/p>\n\n\n\n<p>Returns a JSON object that contains the VPN username.<\/p>\n\n\n\n<ul>\n<li><strong>URL:&nbsp;<\/strong>&lt;base url&gt;\/vam\/v2\/changePassword<\/li>\n\n\n\n<li><strong>Request Method:&nbsp;<\/strong>PUT<\/li>\n<\/ul>\n\n\n\n<p><\/p>\n\n\n\n<h3 class=\"wp-block-heading\">Payload<\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th class=\"has-text-align-left\" data-align=\"left\"><strong>Key<\/strong><\/th><th class=\"has-text-align-left\" data-align=\"left\"><strong>Type<\/strong><\/th><th class=\"has-text-align-left\" data-align=\"left\"><strong>Pass in<\/strong><\/th><th class=\"has-text-align-left\" data-align=\"left\"><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>X-AccessToken<\/code>*<\/td><td class=\"has-text-align-left\" data-align=\"left\">String<\/td><td class=\"has-text-align-left\" data-align=\"left\">Header  <\/td><td class=\"has-text-align-left\" data-align=\"left\"><kbd>accessToken<\/kbd> retrieved from <a href=\"https:\/\/www.purewl.com\/developer\/guides\/api\/api-reference\/api-access-authentication\/#get-access-token\" data-type=\"link\" data-id=\"https:\/\/www.purewl.com\/developer\/guides\/api\/api-reference\/inventory-management\/countries\/\" target=\"_blank\" rel=\"noreferrer noopener\">Get Access Token<\/a> endpoint<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>vpnUsername<\/code>*<\/td><td class=\"has-text-align-left\" data-align=\"left\">String<\/td><td class=\"has-text-align-left\" data-align=\"left\">Body<\/td><td class=\"has-text-align-left\" data-align=\"left\">VPN Username<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>newPassword<\/code>*<\/td><td class=\"has-text-align-left\" data-align=\"left\">String<\/td><td class=\"has-text-align-left\" data-align=\"left\">Body<\/td><td class=\"has-text-align-left\" data-align=\"left\">New Password. Password must not contain non ASCII characters like (\u00a3, \u4f60\u597d)<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>confirmNewPassword<\/code>*<\/td><td class=\"has-text-align-left\" data-align=\"left\">String<\/td><td class=\"has-text-align-left\" data-align=\"left\">Body<\/td><td class=\"has-text-align-left\" data-align=\"left\">Should be equal to <code><kbd>newPassword<\/kbd><\/code><\/td><\/tr><\/tbody><\/table><figcaption class=\"wp-element-caption\">(*) Required Parameter<\/figcaption><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\">Response<\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table><thead><tr><th class=\"has-text-align-left\" data-align=\"left\"><strong>Key<\/strong><\/th><th class=\"has-text-align-left\" data-align=\"left\"><strong>Type<\/strong><\/th><th class=\"has-text-align-left\" data-align=\"left\"><strong>Description<\/strong><\/th><\/tr><\/thead><tbody><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>header<\/code><\/td><td class=\"has-text-align-left\" data-align=\"left\">JSON<\/td><td class=\"has-text-align-left\" data-align=\"left\">JSON object that describes return code and message<\/td><\/tr><tr><td class=\"has-text-align-left\" data-align=\"left\"><code>body<\/code><\/td><td class=\"has-text-align-left\" data-align=\"left\">JSON<\/td><td class=\"has-text-align-left\" data-align=\"left\">JSON object that return VPN username<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\">Possible API error codes<\/h3>\n\n\n\n<figure class=\"wp-block-table\"><table><tbody><tr><td><strong>Code<\/strong><\/td><td><strong>Message<\/strong><\/td><td><strong>Description<\/strong><\/td><\/tr><tr><td><code>1801<\/code><\/td><td>There is some problem in changing vpn account password<\/td><td>An error occurred while attempting to change the VPN account password.<\/td><\/tr><tr><td><code>2057<\/code><\/td><td>Account disable \/ deleted (not found).<\/td><td>The account does not exist in the system.<\/td><\/tr><tr><td><code>11001<\/code><\/td><td>The provided username is not valid for this reseller<\/td><td>The provided username is not recognized as valid for the associated reseller.<\/td><\/tr><tr><td><code>11001<\/code><\/td><td>The password limit is a minimum of 12 characters and a maximum of 32 characters.<\/td><td>The password must be between 12 and 32 characters in length.<\/td><\/tr><tr><td><code>11001<\/code><\/td><td>confirmNewPassword does not match<\/td><td>The confirmNewPassword field does not match the new password.<\/td><\/tr><tr><td><code>11001<\/code><\/td><td>Password Policy not match must contain at least one uppercase, lowercase, digit and sepcial characters !@#$%^&amp;,.:{} letter<\/td><td>The password does not meet the required policy.<\/td><\/tr><tr><td><code>100016<\/code><\/td><td>Please follow password length rules. Feel free to contact Admin<\/td><td>The password length should be between 7 &#8211; 51 characters, which does not meet the required length.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n<h3 class=\"wp-block-heading\">Sample Response<\/h3>\n\n\n\n<div class=\"hcb_wrap\"><pre class=\"prism off-numbers lang-json\" data-lang=\"JSON\" data-show-lang=\"1\"><code>{\n  &quot;header&quot;: {\n    &quot;response_code&quot;: 1,\n    &quot;message&quot;: &quot;Password of VPN account has been changed successfully&quot;\n  },\n  &quot;body&quot;: {\n    &quot;vpnUsername&quot;: &quot;xxxxx&quot;\n  }\n}<\/code><\/pre><\/div>\n","protected":false},"excerpt":{"rendered":"<p>Changing a VPN account password via API is an essential feature for maintaining account security and ensuring that users can update their credentials as needed. This functionality allows administrators or users to programmatically update the password of a VPN account, which is critical for managing access and protecting sensitive information. This article provides a technical [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":10017,"menu_order":11,"comment_status":"open","ping_status":"closed","template":"","doc_tag":[],"acf":[],"_links":{"self":[{"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/docs\/10122"}],"collection":[{"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/docs"}],"about":[{"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/types\/docs"}],"author":[{"embeddable":true,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/comments?post=10122"}],"version-history":[{"count":11,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/docs\/10122\/revisions"}],"predecessor-version":[{"id":10881,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/docs\/10122\/revisions\/10881"}],"up":[{"embeddable":true,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/docs\/10017"}],"wp:attachment":[{"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/media?parent=10122"}],"wp:term":[{"taxonomy":"doc_tag","embeddable":true,"href":"https:\/\/www.purewl.com\/developer\/wp-json\/wp\/v2\/doc_tag?post=10122"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}