rt_user_create: Create a user

Description Usage Arguments Value Examples

View source: R/rt_user_create.R

Description

Create a user

Usage

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

Arguments

name

(character) Optional. User name

password

(character) The password

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

(numeric) The ID of the newly-created user

Examples

1
2
3
4
5
6
7
8
## Not run: 
# Create a barebones user with just a name
rt_user_create("Some Person")

# Create user that also has an email address
rt_user_create("Person", email_address = "person@example.com")

## End(Not run)

rt documentation built on May 15, 2021, 9:06 a.m.