suso_PwCheck: Utility function to check if credentials are correct

View source: R/suso_api_credentials.R

suso_PwCheckR Documentation

Utility function to check if credentials are correct

Description

This function returns a 200 status if the correct credentials have been provided. If credentials are correct but user is not eligible to access the workspace, then a 403 error is returned.

Usage

suso_PwCheck(
  server = suso_get_api_key("susoServer"),
  apiUser = suso_get_api_key("susoUser"),
  apiPass = suso_get_api_key("susoPass"),
  workspace = NULL,
  token = NULL
)

Arguments

server

Survey Solutions Server

apiUser

API user

apiPass

API password

workspace

server workspace, if nothing provided, defaults to primary

token

If Survey Solutions server token is provided apiUser and apiPass will be ignored


michael-cw/SurveySolutionsAPI documentation built on Jan. 14, 2024, 2:58 a.m.