khis_cred {khisr}R Documentation

Sets the KHIS Credentials

Description

Sets the KHIS Credentials

Usage

khis_cred(
  config_path = NULL,
  username = NULL,
  password = NULL,
  base_url = NULL
)

Arguments

config_path

An optional parameters that contains the path to configuration file with username and password.

username

The KHIS username. Can be optional if config_path is already provided

password

The KHIS password. Can be optional if config_path is already provided.

base_url

The base url used for the KHIS instance. The default is NULL which is the https://hiskenya.org/api

Details

The credentials can be provided using a configuration file (more secure) or providing username and password arguments. The config_path is considered more secure since credentials will not appear in the code.

Value

No return value

See Also

Other credential functions: khis_cred_clear(), khis_has_cred(), khis_username()

Examples


# Load username and password
khis_cred(username = 'khis_username', password = 'PASSWORD')

[Package khisr version 1.0.2 Index]