ndex_delete_user: Delete User

Description Usage Arguments Value REST query Note Examples

View source: R/ndex_users.R

Description

Deletes the authenticated user, removing any other objects in the database that depend on the user

Usage

1
ndex_delete_user(ndexcon, userId)

Arguments

ndexcon

object of class NDExConnection linkndex_connect

userId

character; unique ID (UUID) of the user

Value

NULL if successfull, else an error is thrown

REST query

GET: ndex_config$api$user$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
## Establish a server connection with credentials 
# ndexcon = ndex_connect('MyAccountName', 'MyPassword')
## Find user and get its id
# user = ndex_find_user_byName(ndexcon, 'SomeUserName')
# userId = user$externalId
## Delete user
# ndex_delete_user(ndexcon, userId)
NULL

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