ndex_group_delete_membership: Remove a Group Member

In frankkramer-lab/ndexr: NDEx R client library

Remove a Group Member

Description

Removes the member from the group

Usage

ndex_group_delete_membership(ndexcon, groupId, userId)

Arguments

ndexcon	object of class NDExConnection linkndex_connect
groupId	character; unique ID (UUID) of the group
userId	character; unique ID (UUID) of the user

Value

Empty string ("") on success, else error

REST query

DELETE: ndex_config$api$user$membership$delete

Note

Requires an authorized user! (ndex_connect with credentials)

Compatible to NDEx server version 2.0

Examples

## Establish a server connection with credentials 
# ndexcon = ndex_connect('MyAccountName', 'MyPassword')
## Find user and get own id
# user = ndex_find_user_byName(ndexcon, 'MyAccountName')
# userId = user$externalId
## Find own groups and get one group id
# groups = ndex_user_list_groups(ndexcon, userId)
# groupId = groups[1,"externalId"]
## Find an other user of the group and get the id
# users = ndex_group_list_users(ndexcon, groupId)
## Choose one user 
# userId = users[1,"externalId"]
## Remove user from the group
# ndex_group_delete_membership(ndexcon, groupId, userId)
NULL

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