You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.rst
+42-11Lines changed: 42 additions & 11 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -71,7 +71,11 @@ Unlock a door
71
71
Authentication Method
72
72
~~~~~~~~~~~~~~~~~~~~~
73
73
74
-
The SDK supports API key authentication mechanism.
74
+
The SDK supports API key and personal access token authentication mechanisms.
75
+
Authentication may be configured by passing the corresponding options directly to the ``Seam`` constructor, or with the more ergonomic static factory methods.
76
+
77
+
API Key
78
+
^^^^^^^
75
79
76
80
An API key is scoped to a single workspace and should only be used on the server.
77
81
Obtain one from the Seam Console.
@@ -87,14 +91,38 @@ Obtain one from the Seam Console.
87
91
# Pass as a keyword argument to the constructor
88
92
seam = Seam(api_key="your-api-key")
89
93
94
+
# Use the factory method
95
+
seam = Seam.from_api_key("your-api-key")
96
+
97
+
Personal Access Token
98
+
^^^^^^^^^^^^^^^^^^^^^
99
+
100
+
A Personal Access Token is scoped to a Seam Console user.
101
+
Obtain one from the Seam Console.
102
+
A workspace id must be provided when using this method and all requests will be scoped to that workspace.
0 commit comments