ndex_group_delete_membership: Remove a Group Member

Description Usage Arguments Value REST query Note Examples

View source: R/ndex_groups.R

Description

Removes the member from the group

Usage

1
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

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
## 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

ndexr documentation built on April 29, 2020, 5:20 a.m.