Skip to content

Commit 97c99f3

Browse files
author
Sam Stenvall
committed
Document the easiest way to test if credentials are correct (closes #28)
1 parent dd9bcae commit 97c99f3

1 file changed

Lines changed: 18 additions & 0 deletions

File tree

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,24 @@ c.SetTimeout(time.Second * 30)
4040
svc := service.New(c)
4141
```
4242

43+
### Validating credentials
44+
45+
The easiest way to check whether the client credentials are correct is to issue a call to `GetAccount()` (since it
46+
doesn't require any parameters).
47+
48+
```go
49+
username := "completely"
50+
password := "invalid"
51+
52+
svc := service.New(client.New(username, password))
53+
54+
_, err := svc.GetAccount()
55+
56+
if err != nil {
57+
panic("Invalid credentials")
58+
}
59+
```
60+
4361
The rest of these examples assume you already have a service object configured and named `svc`.
4462

4563
### Retrieving a list of servers

0 commit comments

Comments
 (0)