From e0454bce299d29eb3f1477576c2b12ddaac89447 Mon Sep 17 00:00:00 2001 From: Matt Kantor Date: Thu, 19 Nov 2015 09:07:23 -0800 Subject: [PATCH] Document that api_url must be set when using a refresh_token. --- README.md | 5 +++-- config/login.yml.example | 1 + 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 4b56b13..516c994 100644 --- 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 index 657b281..024b968 100644 --- 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 => , :refresh_token => ) :refresh_token: my_token_string