authenticateUser: authenticate a user to CCH portal

Description Usage Arguments Details Value

View source: R/authenticateUser.R

Description

returns a token that can be used in POST or PUT methods

Usage

1
authenticateUser(username, password)

Arguments

username

an active directory username (e.g., 'bbadger')

password

a character password for the active directory username. Will be prompted for password if missing and in interactive mode.

Details

if authenticateUser is called with a username argument, username is stored in the R session environment, and future calls to authenticateUser within the same R session can use the password argument only (e.g., authenticateUser(password = '12345')) The username and password can also be specified in the config file

Value

a character token, or the status code if not 200


USGS-R/hazardItems documentation built on Aug. 15, 2020, 11:28 a.m.