credentials_app_default: Load Application Default Credentials

Description Usage Arguments Value See Also Examples

View source: R/credentials_app_default.R

Description

Loads credentials from a file identified via a search strategy known as Application Default Credentials (ADC). The hope is to make auth "just work" for someone working on Google-provided infrastructure or who has used Google tooling to get started. A sequence of paths is consulted, which we describe here, with some abuse of notation. ALL_CAPS represents the value of an environment variable and %||% is used in the spirit of a null coalescing operator.

1
2
3
4
5
6
GOOGLE_APPLICATION_CREDENTIALS
CLOUDSDK_CONFIG/application_default_credentials.json
# on Windows:
(APPDATA %||% SystemDrive %||% C:)\gcloud\application_default_credentials.json
# on not-Windows:
~/.config/gcloud/application_default_credentials.json

If the above search successfully identifies a JSON file, it is parsed and ingested either as a service account token or a user OAuth2 credential.

Usage

1

Arguments

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 "https://www.googleapis.com/auth/userinfo.email" scope is unconditionally included. This grants permission to retrieve the email address associated with a token; gargle uses this to index cached OAuth tokens. This grants no permission to view or send email. It is considered a low value scope and does not appear on the consent screen.

...

Additional arguments passed to all credential functions.

Value

An httr::TokenServiceAccount or an httr::Token2.0 or NULL.

See Also

https://cloud.google.com/docs/authentication/production#providing_credentials_to_your_application

https://cloud.google.com/sdk/docs/

Other credential functions: credentials_byo_oauth2, credentials_gce, credentials_service_account, credentials_user_oauth2, token_fetch

Examples

1
2
3
4
## Not run: 
credentials_app_default()

## End(Not run)

r-pkgs/gargle documentation built on Aug. 20, 2019, 8:42 a.m.