Skip to content
Elixir package for Oauth authentication via Google Cloud APIs
Branch: master
Clone or download
Type Name Latest commit message Commit time
Failed to load latest commit information.
config Honor credentials from gcloud application defaults Oct 5, 2017
lib Drop Poison for Jason Jan 14, 2019
.travis.yml tweak the Travis CI test matrix a bit more Jan 21, 2019
mix.exs release v1.0.1 Jan 28, 2019
mix.lock update ex_doc Jan 21, 2019

Build Status


Google + Auth = Goth

A simple library to generate and retrieve OAuth2 tokens for use with Google Cloud Service accounts.

It can either retrieve tokens using service account credentials or from Google's metadata service for applications running on Google Cloud Platform.


  1. Add Goth to your list of dependencies in mix.exs:
def deps do
  [{:goth, "~> 0.8.0"}]
  1. Pass in your credentials json downloaded from your GCE account:
config :goth,
  json: "path/to/google/json/creds.json" |>!

Or, via an ENV var:

config :goth, json: {:system, "GCP_CREDENTIALS"}

Or, via your own config module:

config :goth, config_module: MyConfigMod
defmodule MyConfigMod do
  use Goth.Config

  def init(config) do
    {:ok, Keyword.put(config, :json, System.get_env("MY_GCP_JSON_CREDENTIALS"))}

You can also use a JSON file containing an array of service accounts to be able to use different identities in your application. Each service account will be identified by its client_email, which can be passed to Goth.Token.for_scope/1 to specify which service account to use.

For example, if your JSON file contains the following:

    "client_email": "",
    "client_email": "",

You can use the following to get a token for the second service account:

def get_token do
  {:ok, token} = Goth.Token.for_scope({

You can skip the last step if your application will run on a GCP or GKE instance with appropriate permissions.

If you need to set the email account to impersonate. For example when using service accounts

config :goth,
  json: {:system, "GCP_CREDENTIALS"},
  actor_email: ""

Alternatively, you can pass your sub email on a per-call basis, for example:


If you need to disable Goth in certain environments, you can set a disabled flag in your config:

config :goth,
  disabled: true

This initializes Goth with an empty config, so any attempts to actually generate tokens will fail.


Retrieve a token:

Call Token.for_scope/1 passing in a string of scopes, separated by a space:

alias Goth.Token
{:ok, token} = Token.for_scope("")
    expires: 1453356568,
    token: "ya29.cALlJ4ICWRvMkYB-WsAR-CZnExE459PA7QPqKg5nei9y2T9-iqmbcgxq8XrTATNn_BPim",
    type: "Bearer"
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.