Document that api_url must be set when using a refresh_token.

flexera-public · Nov 19, 2015 · e0454bc · e0454bc
1 parent 9278bd5
commit e0454bc
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -112,8 +112,9 @@ HTTP calls can sometimes fail. To enable retrying idempotent requests automatica
 Multiple accounts can be managed by using the api\_url and account\_id attributes on the client.
 
 The api\_url attribute allows users to modify the shard which the client is being used to connect to.
-This should not be required as the client will find the correct shard using the account id but is
-included for completeness.
+This should not be required as the client will find the correct shard using the account id (except
+when using a refresh\_token for authorization; in this case api\_url must be set to your shard
+address).
 
 Example:
 

diff --git a/config/login.yml.example b/config/login.yml.example
@@ -34,6 +34,7 @@
 # Please be careful! This is a user-specific OAuth 2.0 refresh token representing a grant with unrestricted scope.
 # Anyone who possesses it can login to RightScale's API and perform requests on this account with all of your permissions.
 # For more information, consult http://support.rightscale.com/12-Guides/03-Rightscale_API/OAuth
+# Note that api_url must be set to your shard when refresh_token is used.
 # ex: @client = RightApi::Client.new(:api_url => "https://us-x.rightscale.com", :account_id => <account_id>, :refresh_token => <token>)
 :refresh_token: my_token_string