gargle: credentials_user_oauth2 – R documentation

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

credentials_user_oauth2

Get an OAuth token for a user

Description

Consults the token cache for a suitable OAuth token and, if unsuccessful, gets a token via the browser flow. A cached token is suitable if it's compatible with the user's request in this sense:

OAuth app must be same.
Scopes must be same.
Email, if provided, must be same.

gargle is very conservative about using OAuth tokens discovered in the user's cache and will generally seek interactive confirmation. Therefore, in a non-interactive setting, it's important to explicitly specify the "email" of the target account or to explicitly authorize automatic discovery. See gargle2.0_token(), which this function wraps, for more. Non-interactive use also suggests it might be time to use a service account token.

Usage

credentials_user_oauth2(
  scopes = NULL,
  app = gargle_app(),
  package = "gargle",
  ...
)

Arguments

`scopes`	A character vector of scopes to request. Pick from those listed at https://developers.google.com/identity/protocols/oauth2/scopes. For certain token flows, the `"https://www.googleapis.com/auth/userinfo.email"` scope is unconditionally included. This grants permission to retrieve the email address associated with a token; gargle uses this to index cached OAuth tokens. This grants no permission to view or send email. It is considered a low value scope and does not appear on the consent screen.
`app`	An OAuth consumer application, created by `httr::oauth_app()`.
`package`	Name of the package requesting a token. Used in messages.
`...`	Arguments passed on to `gargle2.0_token` `email` Optional. Allows user to target a specific Google identity. If specified, this is used for token lookup, i.e. to determine if a suitable token is already available in the cache. If no such token is found, `email` is used to pre-select the targetted Google identity in the OAuth chooser. Note, however, that the email associated with a token when it's cached is always determined from the token itself, never from this argument. Use `NA` or `FALSE` to match nothing and force the OAuth dance in the browser. Use `TRUE` to allow email auto-discovery, if exactly one matching token is found in the cache. Defaults to the option named "gargle_oauth_email", retrieved by `gargle_oauth_email()`. `use_oob` Whether to prefer "out of band" authentication. Defaults to the option named "gargle_oob_default", retrieved via `gargle_oob_default()`. `cache` Specifies the OAuth token cache. Defaults to the option named "gargle_oauth_cache", retrieved via `gargle_oauth_cache()`. `user_params` Named list holding endpoint specific parameters to pass to the server when posting the request for obtaining or refreshing the access token. `type` content type used to override incorrect server response `credentials` Advanced use only: allows you to completely customise token generation.

Value

A Gargle2.0 token.

Examples

## Not run: 
## Drive scope, built-in gargle demo app
scopes <- "https://www.googleapis.com/auth/drive"
credentials_user_oauth2(scopes, app = gargle_app())

## bring your own app
app <- httr::oauth_app(
  appname = "my_awesome_app",
  key = "keykeykeykeykeykey",
  secret = "secretsecretsecret"
)
credentials_user_oauth2(scopes, app)

## End(Not run)

gargle

Utilities for Working with Google APIs

v1.1.0

MIT + file LICENSE

Authors

Jennifer Bryan [aut, cre] (<https://orcid.org/0000-0002-6983-2759>), Craig Citro [aut], Hadley Wickham [aut] (<https://orcid.org/0000-0003-4757-117X>), Google Inc [cph], RStudio [cph, fnd]

Initial release