googleAuthR: gar_auth_configure – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

gar_auth_configure

Edit and view auth configuration

Description

These functions give more control over and visibility into the auth configuration than [gar_auth()] does. 'gar_auth_configure()' lets the user specify their own: * OAuth app, which is used when obtaining a user token. * API key. If googleAuthR is de-authorized via [gar_deauth()], all requests are sent with an API key in lieu of a token. See the vignette [How to get your own API credentials](https://gargle.r-lib.org/articles/get-api-credentials.html) for more. If the user does not configure these settings, internal defaults are used. 'gar_oauth_app()' and 'gar_api_key()' retrieve the currently configured OAuth app and API key, respectively.

Usage

gar_auth_configure(app, path, api_key)

gar_api_key()

gar_oauth_app()

Arguments

`app`	OAuth app, in the sense of [httr::oauth_app()].
`path`	JSON downloaded from Google Cloud Platform Console, containing a client id (aka key) and secret, in one of the forms supported for the `txt` argument of `jsonlite::fromJSON()` (typically, a file path or JSON string).
`api_key`	API key.

Value

* 'gar_auth_configure()': An object of R6 class [gargle::AuthState], invisibly. * 'gar_oauth_app()': the current user-configured [httr::oauth_app()]. * 'gar_api_key()': the current user-configured API key.

Examples

# see and store the current user-configured OAuth app (probaby `NULL`)
(original_app <- gar_oauth_app())

# see and store the current user-configured API key (probaby `NULL`)
(original_api_key <- gar_api_key())

if (require(httr)) {
  # bring your own app via client id (aka key) and secret
  google_app <- httr::oauth_app(
    "my-awesome-google-api-wrapping-package",
    key = "123456789.apps.googleusercontent.com",
    secret = "abcdefghijklmnopqrstuvwxyz"
  )
  google_key <- "the-key-I-got-for-a-google-API"
  gar_auth_configure(app = google_app, api_key = google_key)

  # confirm the changes
  gar_oauth_app()
  gar_api_key()
}

## Not run: 
## bring your own app via JSON downloaded from Google Developers Console
gar_auth_configure(
  path = "/path/to/the/JSON/you/downloaded/from/google/dev/console.json"
)

## End(Not run)

# restore original auth config
gar_auth_configure(app = original_app, api_key = original_api_key)

googleAuthR

Authenticate and Create Google APIs

v1.4.0

MIT + file LICENSE

Authors

Mark Edmondson [aut, cre] (<https://orcid.org/0000-0002-8434-3881>), Jennifer Bryan [ctb], Johann deBoer [ctb], Neal Richardson [ctb], David Kulp [ctb], Joe Cheng [ctb]

Initial release