Skip to content

Commit 3043753

Browse files
committed
Document change_password rpc
1 parent 6057e89 commit 3043753

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed

docs/rpc/auth/change-password.md

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# change_password
2+
3+
## Description
4+
5+
Sometimes a BTC Map admin sets up an account for you with a username and a password. If you didn't make that password yourself, you should change it.
6+
7+
Also, use this if you think your current password sucks or might have been leaked.
8+
9+
Just so you know, BTC Map never stores your actual password. We only keep a hashed version of it on the backend.
10+
11+
That doesn't mean you can safely reuse passwords from other services though. If the backend is compromised and you're logging in, third parties could still intercept your password. We recommend generating a unique, strong password for your BTC Map account.
12+
13+
## Input
14+
15+
```json
16+
{
17+
"username": "Satoshi",
18+
"old_password": "oldpwd",
19+
"new_password": "verystrongnewpwd!"
20+
}
21+
```
22+
23+
## Output
24+
25+
```json
26+
{
27+
"time_ms": 300
28+
}
29+
```
30+
31+
## Examples
32+
33+
### btcmap-cli
34+
35+
```bash
36+
btcmap-cli change-password Satoshi oldpwd verystrongnewpwd!
37+
```
38+
39+
### curl
40+
41+
```bash
42+
curl --header 'Content-Type: application/json' \
43+
--request POST \
44+
--data '{"jsonrpc":"2.0","method":"change_password","params":{"username":"Satoshi","old_password":"oldpwd","new_password":"verystrongnewpwd!"},"id":1}' \
45+
https://api.btcmap.org/rpc
46+
```

0 commit comments

Comments
 (0)