get_groups: Get group information from the Posit Connect server

In rstudio/connectapi: Utilities for Interacting with the 'Posit Connect' Server API

Get group information from the Posit Connect server

Description

Get group information from the Posit Connect server

Usage

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 number of groups to retrieve before paging stops. limit will be ignored is prefix is not NULL. To limit results when prefix is not NULL, change page_size.

Details

Please see https://docs.posit.co/connect/api/#get-/v1/groups for more information.

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.

See Also

Other groups functions: get_group_content(), get_group_members()

Examples

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

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

## End(Not run)

rstudio/connectapi documentation built on Dec. 20, 2024, 1:48 p.m.