add optional filters to get_* functions

[kmasiello]

Many Connect API endpoints have optional filters for queries. Simplify connectapi queries by implementing these filters.

get_groups

• https://docs.rstudio.com/connect/api/#get-/v1/groups
• parameter prefix: Filters groups by prefix (group name).

non-existent get_instrumentation (aka get_shiny and get_content)

• https://docs.rstudio.com/connect/api/#tag--Instrumentation
• parameter content_guid: Filter results by content GUID.

get_users

• https://docs.rstudio.com/connect/api/#get-/v1/users
• parameter prefix: Filters users by prefix (username, first name, or last name).
• parameter user_role: Filters by user role.
• parameter account_status: Filter by account status.

[SamEdwardes]

+1

I came across a use case today where I needed to get the details of a specific user (e.g. this endpoint: /v1/users/{guid}).

The only working solution I found was to call the API directly:

library(connectapi)
library(glue)
library(httr)

client <- connect()
user_guid <- user_guid_from_username(client, "sam.edwardes")
api_key <- Sys.getenv("CONNECT_API_KEY")
response <- GET(
    glue("{client$server}/__api__/v1/users/{user_guid}"),
    add_headers(Authorization = glue("Key {api_key}"))
)
user_data <- content(response)
user_data$email

[toph-allen]

Closing, as I think these have all been implemented:

• get_users prefix already existed by the time user_role and account_status were implemented: feat: filter users by account_status, user_role #335
• get_groups() supports prefix but also exact matching: Allow exact group matches #261, fix: prevent hanging when calling get_groups with prefix and small page_size #326
• I believe Consolidate get_usage_shiny() and get_usage_static() into get_views() #252 tracks a unified instrumentation endpoint feature request.