gar_attach_auto_auth function

Auto Authentication function for use within .onAttach

Auto Authentication function for use within .onAttach

To be placed within .onAttach to auto load an authentication file from an environment variable.

gar_attach_auto_auth(required_scopes, environment_var = "GAR_AUTH_FILE")

Arguments

  • required_scopes: A character vector of minimum required scopes for this API library

  • environment_var: The name of the environment variable where the file path to the authentication file is kept

    This function works with gar_auto_auth . It is intended to be placed within the .onAttach hook so that it loads when you load your library.

    For auto-authentication to work, the environment variable needs to hold a file path to an existing auth file such as created via gar_auth or a JSON file file download from the Google API console.

Returns

Invisible, used for its side effects of calling auto-authentication.

Examples

## Not run: .onAttach <- function(libname, pkgname){ googleAuthR::gar_attach_auto_auth("https://www.googleapis.com/auth/urlshortener", "US_AUTH_FILE") } ## will only work if you have US_AUTH_FILE environment variable pointing to an auth file location ## .Renviron example US_AUTH_FILE="/home/mark/auth/urlshortnerauth.json" ## End(Not run)

See Also

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

  • Maintainer: Erik Grönroos
  • License: MIT + file LICENSE
  • Last published: 2024-05-22