{"_id":"56ec413636bc8e0e00f190e3","category":{"_id":"5692b19ffe72e00d00e4f0a8","__v":10,"pages":["5692b1ec72d4580d0081e96b","5692b39b72d4580d0081e96f","56951b250c650a2300250544","569520590c650a2300250553","56952277caa32519009c410a","569523782e5eb41700901a7e","56992a43de42370d00727c7c","56b8acb443bbd10d0081d148","56ec413636bc8e0e00f190e3","56ec46068fac371700005d12"],"project":"563cc7119799fb0d00047685","version":"563cc7119799fb0d00047688","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-01-10T19:31:43.021Z","from_sync":false,"order":12,"slug":"fix-api","title":"Users"},"version":{"_id":"563cc7119799fb0d00047688","__v":17,"project":"563cc7119799fb0d00047685","createdAt":"2015-11-06T15:28:17.683Z","releaseDate":"2015-11-06T15:28:17.683Z","categories":["563cc7129799fb0d00047689","566f37f37ffa002300c3cd5b","56914e9bd47b020d002225ac","5692b19ffe72e00d00e4f0a8","56940bc2d8c04d1700e5adb6","56940bc83e9d080d00f064f0","56951b2dfcb1032d0089df7a","569522aecaa32519009c410c","569523ce562335190016da97","569523fddcaf0d1700cb86bf","56980e4a8560a60d00e2c3c3","569921a41693520d002e1305","5699323b7465970d00650b82","569e6cc4fbee990d0072d927","56a2768a0aefae0d00b7fe66","5862e862b8b7fa23009665b7","592835c7bc8bca0f000cc9ff"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Model T","version_clean":"1.0.0","version":"1"},"editedParams2":true,"parentDoc":null,"editedParams":true,"project":"563cc7119799fb0d00047685","user":"563cc6fa8894d20d00014ea3","__v":0,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-18T17:56:06.487Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"name":"","code":"{\n    \"passwordResetID\": \"1832f446-f472-4b9c-9263-6386bedfbb5f\"\n}","language":"json"},{"language":"json","status":400,"name":"","code":"{\n    \"code\": 400,\n    \"message\": \"Invalid value: username\"\n}"},{"code":"{\n  \"username\" : \"INVALID\"\n}","language":"json","status":404}]},"settings":"","examples":{"codes":[{"code":"POST /v1/users/password HTTP/1.1\nHost: api.drivewealth.io\nAccept: application/json\nContent-Type: application/json\n\n{\n    \"username\": \"bobbelcher899\"\n}","language":"http"},{"code":"curl -X POST -H \"Accept: application/json\" -H \"Content-Type: application/json\" -d '{\n    \"username\": \"bobbelcher543\",\n}' \"http://api.drivewealth.io/v1/users/password\"","language":"curl"}]},"method":"post","auth":"required","params":[{"_id":"56b8acb443bbd10d0081d154","ref":"","in":"body","required":true,"desc":"User's username","default":"","type":"string","name":"username"}],"url":"/users/passwords"},"isReference":true,"order":6,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"Password Reset Workflow\",\n  \"body\": \"There are two steps in resetting a user's password. First, call the \\\"[Forgot Password](doc:forgot-password)\\\" method and then call the \\\"[Reset Password](doc:reset-password)\\\" method.\\n\\nIn order to reduce the amount of junk email being sent, we require users to register their email address in our test environment. To register, please send an email to [support:::at:::drivewealth.com](mailto:support@drivewealth.com).\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Response\"\n}\n[/block]\nThe response contains a `passwordResetID` that will be used when calling the Resetting Password method.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Attribute\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`passwordResetID`\",\n    \"0-1\": \"User ID\"\n  },\n  \"cols\": 2,\n  \"rows\": 1\n}\n[/block]","excerpt":"User forgot their password","slug":"forgot-password","type":"endpoint","title":"Forgot Password"}

postForgot Password

User forgot their password

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

username:
required
string
User's username

Examples


Result Format


Documentation

[block:callout] { "type": "warning", "title": "Password Reset Workflow", "body": "There are two steps in resetting a user's password. First, call the \"[Forgot Password](doc:forgot-password)\" method and then call the \"[Reset Password](doc:reset-password)\" method.\n\nIn order to reduce the amount of junk email being sent, we require users to register their email address in our test environment. To register, please send an email to [support@drivewealth.com](mailto:support@drivewealth.com)." } [/block] [block:api-header] { "type": "basic", "title": "Response" } [/block] The response contains a `passwordResetID` that will be used when calling the Resetting Password method. [block:parameters] { "data": { "h-0": "Attribute", "h-1": "Description", "0-0": "`passwordResetID`", "0-1": "User ID" }, "cols": 2, "rows": 1 } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}