rt_user_edit: Edit a user

Description Usage Arguments Value Examples

View source: R/rt_user_edit.R

Description

Edit a user's information.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
rt_user_edit(
  user_id,
  password = NULL,
  name = NULL,
  email_address = NULL,
  real_name = NULL,
  organization = NULL,
  privileged = NULL,
  disabled = NULL,
  ...
)

Arguments

user_id

(numeric) The ID of the User to edit

password

(character) The password

name

(character) Optional. User name

email_address

(character) Optional. User email

real_name

(character) Optional. User real name

organization

(character) Optional. User organization

privileged

(numeric) Optional. User privilege status

disabled

(numeric) Optional. User disabled status

...

Other arguments passed to rt_POST

Value

The ID of the edited user

Examples

1
2
3
4
5
6
7
8
## Not run: 
# First, create a user
user_id <- rt_user_create("Example", "password", "me@example.com")

# Then we can edit it
rt_user_edit(user_id, real_name = "Example User")

## End(Not run)

rt documentation built on April 28, 2020, 1:08 a.m.