Get user information from the Posit Connect server
get_users(src, page_size = 500, prefix = NULL, limit = Inf)
The source object
the number of records to return per page (max 500)
Filters users by prefix (username, first name, or last name). The filter is case insensitive.
The max number of records to return
A tibble with the following columns:
email
: The user's email
username
: The user's username
first_name
: The user's first name
last_name
: The user's last name
user_role
: The user's role. It may have a value of administrator,
publisher or viewer.
created_time
: The timestamp (in RFC3339 format) when the user was
created in the Posit Connect server
updated_time
: The timestamp (in RFC3339 format) when the user was last
updated in the Posit Connect server
active_time
: The timestamp (in RFC3339 format) when the user was last
active on the Posit Connect server
confirmed
: When false, the created user must confirm their account
through an email. This feature is unique to password authentication.
locked
: Whether or not the user is locked
guid
: The user's GUID, or unique identifier, in UUID RFC4122 format
Please see https://docs.posit.co/connect/api/#get-/v1/users for more information.
if (FALSE) {
library(connectapi)
client <- connect()
# get all users
get_users(client, limit = Inf)
}