get_user_details: Gets detailed info about single user

View source: R/users.R

get_user_detailsR Documentation

Gets detailed info about single user

Description

Wrapper for GET /api/v1/users/{id} endpoint

Usage

get_user_details(
  user_id,
  server = Sys.getenv("SUSO_SERVER"),
  workspace = Sys.getenv("SUSO_WORKSPACE"),
  user = Sys.getenv("SUSO_USER"),
  password = Sys.getenv("SUSO_PASSWORD")
)

Arguments

user_id

Character. User ID, user name, or email.

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

Data frame of single user's details.


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