ndex_find_user_byId: Get User By UUID

View source: R/ndex_users.R

ndex_find_user_byIdR Documentation

Get User By UUID

Description

Get User By UUID

Usage

ndex_find_user_byId(ndexcon, userId)

Arguments

ndexcon

object of class NDExConnection linkndex_connect

userId

character; unique ID (UUID) of the user

Value

list of properties describing the user (externalId, emailAddress, website, etc.). Throws error (404) if user isn't found!

REST query

GET: ndex_config$api$user$get$byId

Note

Compatible to NDEx server version 2.0

Examples

## Establish a server connection
ndexcon = ndex_connect()
## Find user by name
user = ndex_find_user_byName(ndexcon, 'ndextutorials')
## Find user by Id
user = ndex_find_user_byId(ndexcon, user$externalId)

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