zendesk: document how to use token-based authentication

Fixes #52.
ducksboard · Jul 8, 2014 · 84a4fec · 84a4fec
1 parent 7bc4ac1
commit 84a4fec
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/libsaas/services/zendesk/service.py b/libsaas/services/zendesk/service.py
@@ -20,10 +20,12 @@ def __init__(self, subdomain, username, password):
             `mycompany.zendesk.com`.
         :vartype subdomain: str
 
-        :var username: The email of the authenticated agent.
+        :var username: The email of the authenticated agent. Use
+            `user@company.com/token` for token-based authentication.
         :vartype username: str
 
-        :var password: The password of the authenticated agent.
+        :var password: The password of the authenticated agent, or an API token
+            if using token-based authentication.
         :vartype password: str
         """
         tmpl = '{0}.zendesk.com/api/v2'