gar_auth: Authorize 'googleAuthR'

Description Usage Arguments Details Value See Also

View source: R/auth.R

Description

Authorize googleAuthR to access your Google user data. You will be directed to a web browser, asked to sign in to your Google account, and to grant googleAuthR access to user data for Google Search Console. These user credentials are cached in a file named .httr-oauth in the current working directory, from where they can be automatically refreshed, as necessary.

Usage

1
gar_auth(token = NULL, new_user = FALSE)

Arguments

token

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

new_user

logical, defaults to FALSE. Set to TRUE if you want to wipe the slate clean and re-authenticate with the same or different Google account. This deletes the .httr-oauth file in current working directory.

Details

These arguments are controlled via options, which, if undefined at the time googleAuthR is loaded, are defined like so:

key

Set to option googleAuthR.client_id, which defaults to a client ID that ships with the package

secret

Set to option googleAuthR.client_secret, which defaults to a client secret that ships with the package

cache

Set to option googleAuthR.httr_oauth_cache, which defaults to TRUE

scopes

Set to option googleAuthR.scopes.selected, which defaults to demo scopes.

To override these defaults in persistent way, predefine one or more of them with lines like this in a .Rprofile file:

1
2
3
options(googleAuthR.client_id = "FOO",
        googleAuthR.client_secret = "BAR",
        googleAuthR.httr_oauth_cache = FALSE)

See Startup for possible locations for this file and the implications thereof.

More detail is available from Using OAuth 2.0 to Access Google APIs. This function executes the "installed application" flow.

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


googleAuthR documentation built on Nov. 17, 2017, 6:30 a.m.