gar_auth: Authorize 'googleAuthR'

Description Usage Arguments Value See Also Examples

View source: R/auth.R

Description

Wrapper of token_fetch

Usage

1
2
3
4
5
6
7
8
9
gar_auth(
  token = NULL,
  email = NULL,
  scopes = getOption("googleAuthR.scopes.selected"),
  app = gar_oauth_app(),
  cache = gargle::gargle_oauth_cache(),
  use_oob = gargle::gargle_oob_default(),
  package = "googleAuthR"
)

Arguments

token

an actual token object or the path to a valid token stored as an .rds file

email

An existing gargle cached email to authenticate with or TRUE to authenticate with the only email available.

scopes

Scope of the request

app

app as specified by gar_auth_configure

cache

Where to store authentication tokens

use_oob

Whther to use OOB browserless authetication

package

The name of the package authenticating

Value

an OAuth token object, specifically a Token2.0, invisibly

See Also

Other authentication functions: gar_attach_auto_auth(), gar_auth_service(), gar_auto_auth(), gar_gce_auth(), get_google_token(), token_exists()

Examples

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

# sets GCP project to auth through
gar_auth_configure(path="path/to/gcp-client.json")

# starts auth process with defaults
gar_auth()

# switching between auth scopes
# first time new scope manual auth, then auto if supplied email   
gar_auth(email = "your@email.com", 
         scopes = "https://www.googleapis.com/auth/drive")
         
# ... query Google Drive functions ...

gar_auth(email = "your@email.com", 
         scopes = "https://www.googleapis.com/auth/bigquery")
         
# ..query BigQuery functions ...


## End(Not run)

googleAuthR documentation built on April 2, 2021, 5:06 p.m.