Skip to content

Commit 54d2e63

Browse files
committed
updating plotly version, adding cloud-platform scopes, updating README re: new Oauth procedures
1 parent 414a98c commit 54d2e63

File tree

2 files changed

+6
-2
lines changed

2 files changed

+6
-2
lines changed

README.rdoc

+5-1
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,10 @@ portal is configured and ready to use:
5454
* For 'Authorized Javascript Origins', enter <code>https://(your hostname)/single_cell</code>
5555
* For 'Authorized redirect URIs', enter <code>https://(your hostname)/single_cell/users/auth/google_oauth2/callback</code>
5656
* Save the client id
57+
* <b>Whitelisting your OAuth Audience</b>
58+
* Once you have exported your OAuth credentials, you will need to have your client id whitelisted to allow it to make
59+
authenticated requests into the FireCloud API as per {OpenID Connect 1.0}[http://openid.net/specs/openid-connect-core-1_0.html#IDTokenValidation]
60+
* Send an email to <b>[email protected]</b> with your OAuth2 client ID so it can be added to the whitelist
5761
* <b>GCP Service Account keys</b>: Regardless of where the portal is deployed, it requires a Google Cloud Platform Service Account in order to make authenticated calls into FireCloud and Google Cloud Storage. Therefore, you must export the default service account key. See https://developers.google.com/identity/protocols/OAuth2ServiceAccount for more information about service accounts. To export the credentials:
5862
* Log into your new GCP project
5963
* Click the navigation menu in the top left and select 'IAM & Admin ' > 'Service Accounts'
@@ -71,7 +75,7 @@ portal is configured and ready to use:
7175
* Log in with the admin account, and select 'Admin Configurations' from the profile menu (top righthand corner)
7276
* At the bottom of the page, in the 'Other Tasks' dropdown, select 'Manage Service Account FireCloud Registration' and click 'Execute Task'
7377
* Fill out all form fields and submit
74-
* <b>Creating a FireCloud Project</b>: Before you can create studies, you will need to create a FireCloud project that will own all the workspaces created in the portal. To do this:
78+
* <b>Creating a FireCloud Project</b>: Once your OAuth audience has been whitelisted, and before you can create studies, you will need to create a FireCloud project that will own all the workspaces created in the portal. To do this:
7579
* Create a {Google Billing Project}[https://software.broadinstitute.org/firecloud/documentation/article?id=9762].
7680
* Using the same Google account that owns the billing project, log into the portal and select 'My Billing Projects' from the profile menu.
7781
* Click 'New Billing Project' at the bottom of the page

app/models/fire_cloud_client.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ class FireCloudClient < Struct.new(:user, :project, :access_token, :api_root, :s
1717
# base url for all API calls
1818
BASE_URL = 'https://api.firecloud.org'
1919
# default auth scopes
20-
GOOGLE_SCOPES = %w(https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/cloud-billing.readonly)
20+
GOOGLE_SCOPES = %w(https://www.googleapis.com/auth/userinfo.profile https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/cloud-billing.readonly https://www.googleapis.com/auth/cloud-platform.read-only)
2121
# constant used for retry loops in process_firecloud_request and execute_gcloud_method
2222
MAX_RETRY_COUNT = 3
2323
# default namespace used for all FireCloud workspaces owned by the 'portal'

0 commit comments

Comments
 (0)