ndex_group_list_users: Get Members of a Group

In frankkramer-lab/ndexr: NDEx R client library

Get Members of a Group

Description

Get Members of a Group

Usage

ndex_group_list_users(ndexcon, groupId, type = NULL, start = NULL, size = NULL)

Arguments

ndexcon	object of class NDExConnection linkndex_connect
groupId	character; unique ID (UUID) of the group
type	character (optional); constrains the type of the returned membership. If not set (or NULL), all permission types will be returned.
start	integer (optional); specifies that the result is the nth page of the requested data.
size	integer (optional); specifies the number of data items in each page.

Value

List of permissions of that group or empty object

REST query

GET: ndex_config$api$group$membership$get

Note

Compatible to NDEx server version 2.0

Examples

## Establish a server connection
ndexcon = ndex_connect()
## Find a group
groups = ndex_find_groups(ndexcon,"Ideker Lab")
groupId = groups[1,"externalId"]
## Find other users of the group
# users = ndex_group_list_users(ndexcon, groupId)
# users = ndex_group_list_users (ndexcon, groupId, type='ADMIN', start=0, size=10)

frankkramer-lab/ndexr documentation built on April 4, 2023, 7:19 p.m.