Skip to contents

Creates a new uers with all the specified properties. Wrapper for POST /api/v1/users endpoint.

Usage

create_user(
  role,
  supervisor = "",
  user_name,
  user_password = "",
  full_name = "",
  phone_number = "",
  email = "",
  verbose = FALSE,
  server = Sys.getenv("SUSO_SERVER"),
  workspace = Sys.getenv("SUSO_WORKSPACE"),
  user = Sys.getenv("SUSO_USER"),
  password = Sys.getenv("SUSO_PASSWORD")
)

Arguments

role

Character. Role in data collection. Accepted values: "Supervisor", "Interviewer"

supervisor

Character. User name of supervisor. Required for role == "Interviewer". Omitted otherwise.

user_name

Character. User name.

user_password

Character. Password for user account.

full_name

Character. Full name of user. (Optional)

phone_number

Character. Phone number for user. (Optional)

email

Character. Email address for user. (Optional)

verbose

Logical. If verbose == TRUE, return logical outcome and print message. Otherwise, be silent.

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

Value

Side-effect on the server: APPROVE interview. If verbose == TRUE, return logical outcome and print message.