Authorization state
An AuthState object manages an authorization state, typically on behalf of
a client package that makes requests to a Google API.
The How to use gargle for auth in a client package
vignette describes a design for wrapper packages that relies on an AuthState
object. This state can then be incorporated into the package's requests for
tokens and can control the inclusion of tokens in requests to the target API.
api_key is the simplest way to associate a request with a specific
Google Cloud Platform project.
A few calls to certain APIs, e.g. reading a public Sheet, can succeed
with an API key, but this is the exception.
app is an OAuth app associated with a specific Google Cloud Platform
project.
This is used in the OAuth flow, in which an authenticated user authorizes
the app to access or manipulate data on their behalf.
auth_active reflects whether outgoing requests will be authorized by an
authenticated user or are unauthorized requests for public resources.
These two states correspond to sending a request with a token versus an
API key, respectively.
cred is where the current token is cached within a session, once one
has been fetched. It is generally assumed to be an instance of
httr::TokenServiceAccount or
httr::Token2.0 (or a subclass thereof), probably
obtained via token_fetch() (or one of its constituent credential
fetching functions).
An AuthState should be created through the constructor function
init_AuthState(), which has more details on the arguments.
packagePackage name.
appAn OAuth consumer application.
api_keyAn API key.
auth_activeLogical, indicating whether auth is active.
credCredentials.
new()
Create a new AuthState
AuthState$new( package = NA_character_, app = NULL, api_key = NULL, auth_active = TRUE, cred = NULL )
packagePackage name.
appAn OAuth consumer application.
api_keyAn API key.
auth_activeLogical, indicating whether auth is active.
credCredentials.
For more details on the parameters, see init_AuthState()
format()
Format an AuthState
AuthState$format(...)
...Not used.
set_app()
Set the OAuth app
AuthState$set_app(app)
appAn OAuth consumer application.
set_api_key()
Set the API key
AuthState$set_api_key(value)
valueAn API key.
set_auth_active()
Set whether auth is (in)active
AuthState$set_auth_active(value)
valueLogical, indicating whether to send requests authorized with user credentials.
set_cred()
Set credentials
AuthState$set_cred(cred)
credUser credentials.
clear_cred()
Clear credentials
AuthState$clear_cred()
get_cred()
Get credentials
AuthState$get_cred()
has_cred()
Report if we have credentials
AuthState$has_cred()
clone()
The objects of this class are cloneable with this method.
AuthState$clone(deep = FALSE)
deepWhether to make a deep clone.
Please choose more modern alternatives, such as Google Chrome or Mozilla Firefox.