get_users {connectapi}

Get user information from the Posit Connect server

Description

Get user information from the Posit Connect server

Usage

get_users(src, page_size = 20, prefix = NULL, limit = 25)

Arguments

src

The source object

page_size

the number of records to return per page (max 500)

prefix

Filters users by prefix (username, first name, or last name). The filter is case insensitive.

limit

The max number of records to return

Details

Please see https://docs.posit.co/connect/api/#getUsers for more information

Value

A tibble with the following columns:

• emailThe user's email

• usernameThe user's username

• first_nameThe user's first name

• last_nameThe user's last name

• user_roleThe user's role. It may have a value of administrator, publisher or viewer.

• created_timeThe timestamp (in RFC3339 format) when the user was created in the Posit Connect server

• updated_timeThe timestamp (in RFC3339 format) when the user was last updated in the Posit Connect server

• active_timeThe timestamp (in RFC3339 format) when the user was last active on the Posit Connect server

• confirmedWhen false, the created user must confirm their account through an email. This feature is unique to password authentication.

• lockedWhether or not the user is locked

• guidThe user's GUID, or unique identifier, in UUID RFC4122 format

Examples

## Not run: 
library(connectapi)
client <- connect()

# get all users
get_users(client, limit = Inf)

## End(Not run)