drop_auth: Authentication for Dropbox

Description Usage Arguments Value References Examples

View source: R/drop_auth.R

Description

This function authenticates you into Dropbox. The documentation for the core Dropbox API provides more details including alternate methods if you desire to reimplement your own.

Usage

1
2
3
4
5
6
7
drop_auth(
  new_user = FALSE,
  key = "mmhfsybffdom42w",
  secret = "l8zeqqqgm1ne5z0",
  cache = TRUE,
  rdstoken = NA
)

Arguments

new_user

Set to TRUE if you need to switch to a new user account or just flush existing token. Default is FALSE.

key

Your application key. rdrop2 already comes with a key/secret but you are welcome to swap out with our own. Since these keys are shipped with the package, there is a small chance they could be voided if someone abuses the key. If you plan to use this in production, or for an internal tool, the recommended practice is to create a new application on Dropbox and use those keys for your purposes.

secret

Your application secret. Like key, rdrop2 comes with a secret but you are welcome to swap out with our own.

cache

By default your credentials are locally cached in a file called .httr-oauth. Set to FALSE if you need to authenticate separately each time.

rdstoken

File path to stored RDS token. In server environments where interactive OAuth is not possible, a token can be created on a desktop client and used in production. See examples.

Value

A Token2.0 object, invisibly

References

API documentation

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
## Not run: 

  # To either read token from .httr-oauth in the working directory or open a
  # web browser to authenticate (and cache a token)
  drop_auth()

  # If you want to overwrite an existing local token and switch to a new
  # user, set new_user to TRUE.
  drop_auth(new_user = TRUE)

  # To store a token for re-use (more flexible than .httr-oauth), save the
  # output of drop_auth and save it to an RDS file
  token <- drop_auth()
  saveRDS(token, "/path/to/tokenfile.RDS")

  # To use a stored token provide token location
  drop_auth(rdstoken = "/path/to/tokenfile.RDS")

## End(Not run)

rdrop2 documentation built on Aug. 5, 2020, 5:07 p.m.

Related to drop_auth in rdrop2...