check_credentials: Check that server credentials are valid
In arthur-shaw/susoapi: Interface for Survey Solutions' APIs

check_credentials

R Documentation

Check that server credentials are valid

Description

Shows server credentials saved in environment variables and .Renviron.

Usage

check_credentials(
  server = Sys.getenv("SUSO_SERVER"),
  workspace = Sys.getenv("SUSO_WORKSPACE"),
  user = Sys.getenv("SUSO_USER"),
  password = Sys.getenv("SUSO_PASSWORD"),
  verbose = FALSE
)

Arguments

`server`	Character. Full server web address (e.g., `https://demo.mysurvey.solutions`, `https://my.domain`)
`workspace`	Character. Name of the workspace whose users to get. In workspace list, value of `NAME`, not `⁠DISPLAY NAME⁠`, for the target workspace.
`user`	Character. API user name
`password`	Character. API password
`verbose`	Logical. If `TRUE`, function returns logical regarding validity of credentials. If `FALSE`, function simply prints information about validity to the console.

Value

If verbose = FALSE (default), side-effect of message printed to the console. If verbose = TRUE, logical: TRUE if credentials valid; FALSE otherwise.

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