gofigr_client {gofigR} | R Documentation |
Creates and configures a GoFigr client. You can login either using a username & password or an API key. See examples.
Description
Username, password, API key and workspace are read from the GoFigr configuration file (~/.gofigr) or environment variables if not supplied:
Usage
gofigr_client(
username = NULL,
password = NULL,
api_key = NULL,
url = NULL,
anonymous = FALSE,
verbose = FALSE,
workspace = NULL,
ignore_config = FALSE
)
Arguments
username |
username (if not using API key) |
password |
password (if not using API key) |
api_key |
API key (if not using password authentication) |
url |
API URL (optional, you generally won't want to modify this) |
anonymous |
whether to login anonymously |
verbose |
set to TRUE to enable verbose output |
workspace |
default workspace (API ID) |
ignore_config |
if TRUE, will ignore environment variables and other external configuration |
Details
* GF_USERNAME or config$username * GF_PASSWORD or config$password * GF_API_KEY or config$api_key * GF_WORKSPACE of config$workspace * GF_URL or config$url
Value
configured GoFigr client which you can pass to other functions
Examples
## Not run: gofigr_client() # use config from ~/.gofigr or environment variables
## Not run: gofigr_client(username="joe", password="abc123") # password login
## Not run: gofigr_client(api_key="abcdef0123456789") # API key login
[Package gofigR version 1.1.0 Index]