Skip to content
This repository has been archived by the owner on Dec 4, 2020. It is now read-only.

Commit

Permalink
Added authentication scope in usage documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
philippelt authored Jul 20, 2016
1 parent 86a2dcb commit 217b7f5
Showing 1 changed file with 10 additions and 1 deletion.
11 changes: 10 additions & 1 deletion usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,8 @@ Constructor
authorization = lnetatmo.ClientAuth( clientId = _CLIENT_ID,
clientSecret = _CLIENT_SECRET,
username = _USERNAME,
password = _PASSWORD
password = _PASSWORD,
scope = "read_station"
)
```

Expand All @@ -165,6 +166,14 @@ Properties, all properties are read-only unless specified :
* **accessToken** : Retrieve a valid access token (renewed if necessary)
* **refreshToken** : The token used to renew the access token (normally should not be used)
* **expiration** : The expiration time (epoch) of the current token
* **scope** : The scope of the required access token (what will it be used for) default to read_station to provide backward compatibility.

Possible values for scope are :
- read_station: to retrieve weather station data (Getstationsdata, Getmeasure)
- read_camera: to retrieve Welcome data (Gethomedata, Getcamerapicture)
- access_camera: to access the camera, the videos and the live stream.

Several value can be used at the same time, ie: 'read_station read_camera'



Expand Down

0 comments on commit 217b7f5

Please sign in to comment.