set_credentials: Set server credentials

In arthur-shaw/susoapi: Interface for Survey Solutions' APIs

Set server credentials

Description

Stores server access credentials for later use. For the current session, credentials are accessible in environment variables. For future sessions, credentials are stored in the .Renviron and loaded upon startup. While functions in this package automatically load the credential set in this way, the credentials can also be accessed via the Sys.getenv function and using the credential name SUSO_SERVER (server address), SUSO_USER (API user name), SUSO_PASSWORD (API user password)

Usage

set_credentials(server, workspace, user, password)

Arguments

server	Character. Full server web address (e.g., https://demo.mysurvey.solutions, https://my.domain)
workspace	Character. Workspace name. In workspace list, value of NAME, not ⁠DISPLAY NAME⁠, for the target workspace.
user	Character. API user name
password	Character. API password

Value

Environment variables SUSO_SERVER, SUSO_WORKSPACE, SUSO_USER, SUSO_PASSWORD

arthur-shaw/susoapi documentation built on Oct. 15, 2024, 3:44 a.m.