Authorize googledrive
Authorize googledrive to view and manage your Drive files. This function is a
wrapper around gargle::token_fetch()
.
By default, you are directed to a web browser, asked to sign in to your
Google account, and to grant googledrive permission to operate on your
behalf with Google Drive. By default, these user credentials are cached in a
folder below your home directory, ~/.R/gargle/gargle-oauth
, from where
they can be automatically refreshed, as necessary. Storage at the user
level means the same token can be used across multiple projects and
tokens are less likely to be synced to the cloud by accident.
If you are interacting with R from a web-based platform, like RStudio
Server or Cloud, you need to use a variant of this flow, known as
out-of-band auth ("oob"). If this does not happen automatically, you
can request it yourself with use_oob = TRUE
or, more persistently, by
setting an option via options(gargle_oob_default = TRUE)
.
drive_auth( email = gargle::gargle_oauth_email(), path = NULL, scopes = "https://www.googleapis.com/auth/drive", cache = gargle::gargle_oauth_cache(), use_oob = gargle::gargle_oob_default(), token = NULL )
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, |
path |
JSON identifying the service account, in one of the forms
supported for the |
scopes |
A character vector of scopes to request. Pick from those listed at https://developers.google.com/identity/protocols/googlescopes. For certain token flows, the
|
cache |
Specifies the OAuth token cache. Defaults to the option named
"gargle_oauth_cache", retrieved via |
use_oob |
Whether to prefer "out of band" authentication. Defaults to
the option named "gargle_oob_default", retrieved via
|
token |
A token with class Token2.0 or an object of
httr's class |
Most users, most of the time, do not need to call drive_auth()
explicitly – it is triggered by the first action that requires
authorization. Even when called, the default arguments often suffice.
However, when necessary, this function allows the user to explicitly:
Declare which Google identity to use, via an email address. If there are multiple cached tokens, this can clarify which one to use. It can also force googledrive to switch from one identity to another. If there's no cached token for the email, this triggers a return to the browser to choose the identity and give consent.
Use a service account token.
Bring their own Token2.0.
Specify non-default behavior re: token caching and out-of-bound authentication.
For details on the many ways to find a token, see
gargle::token_fetch()
. For deeper control over auth, use
drive_auth_configure()
to bring your own OAuth app or API key.
Read more about gargle options, see gargle::gargle_options.
Other auth functions:
drive_auth_configure()
,
drive_deauth()
## Not run: ## load/refresh existing credentials, if available ## otherwise, go to browser for authentication and authorization drive_auth() ## see user associated with current token drive_user() ## force use of a token associated with a specific email drive_auth(email = "jenny@example.com") drive_user() ## force a menu where you can choose from existing tokens or ## choose to get a new one drive_auth(email = NA) ## use a 'read only' scope, so it's impossible to edit or delete files drive_auth( scopes = "https://www.googleapis.com/auth/drive.readonly" ) ## use a service account token drive_auth(path = "foofy-83ee9e7c9c48.json") ## End(Not run)
Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.