updateUser: Update User Details

View source: R/UserFunctions.R

updateUserR Documentation

Update User Details

Description

This function modifies one or more attributes of a user.

Usage

updateUser(
  userId,
  school_id = NULL,
  building_id = NULL,
  school_uid = NULL,
  name_title = NULL,
  name_title_show = NULL,
  name_first = NULL,
  name_first_preferred = NULL,
  name_middle = NULL,
  name_middle_show = NULL,
  name_last = NULL,
  name_display = NULL,
  username = NULL,
  primary_email = NULL,
  position = NULL,
  gender = NULL,
  grad_year = NULL,
  birthday_date = NULL,
  password = NULL,
  role_id = NULL,
  email_login_info = NULL,
  profile_url = NULL,
  tz_name = NULL,
  parents = NULL,
  parent_uids = NULL,
  advisor_uids = NULL,
  child_uids = NULL,
  send_message = NULL,
  synced = NULL,
  profile_picture_fid = NULL,
  additional_buildings = NULL
)

Arguments

userId

Can be found by navigating to the Schoology user information page.

object

Must be created via createUserObject().

Value

A dataframe of updated user details.

References

API Documentation


sterfa02/SchoologyAPI documentation built on Jan. 10, 2023, 11:27 p.m.