authenticate.RdAuthenticates with CellEngine.
authenticate(username = NA, password = NA, otp = NA, token = NA)Your username or email address. If omitted, not available
from the environment variable CELLENGINE_USERNAME, and running in an
interactive session, a prompt will be displayed.
Your password. If omitted, not available from the environment
variable CELLENGINE_PASSWORD, and running in RStudio or the getPass library
is installed, a prompt will be displayed.
A one-time passcode, if your account is configured with two-factor authentication. If omitted and in an interactive session, a prompt will be displayed if required. Note that this must be a string.
A Personal Access Token. See the CellEngine documentation for more information. If provided, username, password, and otp will be ignored.
There are two ways of authenticating:
Username and password. Use this to authenticate a user in a dynamic session.
API token. This is the preferred method for unattended applications (such as LIMS integrations) because it allows a limited set of permissions to be granted to the application.
These values can either be passed to the authenticate() function, or
provided through environment variables named CELLENGINE_USERNAME,
CELLENGINE_PASSWORD and CELLENGINE_AUTH_TOKEN. otp cannot be provided
as an environment variable due to its short lifespan.
For security, you should not store your password in plain text, and you should ensure that your R history does not store your password. Instead, consider setting an environment variable (see examples).
if (FALSE) { # \dontrun{
# Attempts to retrieve credentials from environment variables, falling back
# to prompting for username and password (and OTP if configured):
authenticate()
# Attempts to retrieve credentials from environment variables, falling back
# to prompting for password (and OTP if configured):
authenticate("username")
# Using an API token:
authenticate(token = "cep_abcdefghijklmnopqrstuvwxyz1234567890")
} # }