Skip to content

Latest commit

 

History

History
48 lines (39 loc) · 2.61 KB

Google-Auth.md

File metadata and controls

48 lines (39 loc) · 2.61 KB
Raw

Client credentials

All members of the WormBase organisation should have a Google account, and thus the names service uses Google-Auth as the mechanism for authentication.

Log in to the name service website using your wormbase google email (ending on @wormbase.org).

API Authorization token

As authorization mechanism, the names service requires that either a temporary Google Auth Code (for exchange using the identity endpoint) or a valid ID token is passed in through the HTTP(S) request Authorization header sent to all API endpoints. By default, ID tokens expire after 1 hour. To obtain a token that will be valid longer than 1 hour, which can be used for calling the API in scripting:

  1. Log in to the name service website with your personal wormbase google account
  2. Browse to your profile page (/me).
  3. Click the store token button to store the current ID token as an API token, and copy the token that shows up in the textbox above (by clicking the copy to clipboard button). This API token will only be visible once upon storing it to the database, and not after refreshing the page or in any later sessions.
  • If you forgot your API token, or the token was potentially leaked, click the store token button again to store and display a new token and invalidate the old one.
  • If you no longer need (direct) API access to the name service, click the revoke token button to revoke the currently stored token without generating a new one.

The token should then be passed in the header as described below for direct API access. For example; given a suitable JSON file for the payload, the curl command below creates a number of genes via the names service batch API:

curl -H "Content-type: application/json" \
     -H "Authorization: Token $ID_TOKEN" \
     --data @payload.json \
     https://names.wormbase.org/api/batch/gene

Google Oath 2.0 Clients

The Google Oath 2.0 clients used by the Name service can be accessed through the credentials section of the Google Developers Console. The Name Service uses two Google Oath 2.0 Client applications for different environments:

  • Web - Dev
  • Web - Prod

For local testing and development, use the application credentials of the Web - Dev application. For applications deployed to the stage or production environment, use the Web - Prod application credentials.

Click on the respective application name in the console to access the details page showing the Client ID and Client secret to be used by the Name Service to enable Google Authentication.