suso_archUSR: Survey Solutions API call archive user

In michael-cw/SurveySolutionsAPI: Comprehensive API access to your Survey Solutions Server

Survey Solutions API call archive user

Description

(Un-)Archive user

Usage

suso_archUSR(
  url = suso_get_api_key("susoServer"),
  usr = suso_get_api_key("susoUser"),
  pass = suso_get_api_key("susoPass"),
  uid = NULL,
  archive = F,
  workspace = NULL,
  token = NULL
)

Arguments

url	Survey Solutions server address
usr	Survey Solutions API user
pass	Survey Solutions API password
uid	user id
archive	if TRUE user will be archived or statys archived, if FALSE user will be unarchived or stays unarchived
workspace	If workspace name is provide requests are made regarding this specific workspace, if no workspace is provided defaults to primary workspace.
token	If Survey Solutions server token is provided usr and pass will be ignored

Examples

## Not run: 
# you can archive a user by archive=T
suso_archUSR(
          workspace = "myworkspace",
          uid = "xxxx-xxxx-xxxx-xxx",
          archive = TRUE
          )
# and unarchive a user by archive=F
suso_archUSR(
          workspace = "myworkspace",
          uid = "xxxx-xxxx-xxxx-xxx",
          archive = FALSE
          )

## End(Not run)

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