Get group information from the Posit Connect server

Source: R/get.R

Get group information from the Posit Connect server

get_groups(src, page_size = 500, prefix = NULL, limit = Inf)

Arguments

src

The source object

page_size

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

prefix

Filters groups by prefix (group name). The filter is case insensitive.

limit

The max number of groups to return

Value

A tibble with the following columns:

  • guid: The unique identifier of the group

  • name: The group name

  • owner_guid: The group owner's unique identifier. When using LDAP or Proxied authentication with group provisioning enabled this property will always be null.

Details

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

Examples

if (FALSE) {
library(connectapi)
client <- connect()

# get all groups
get_groups(client, limit = Inf)
}