ndex_verify_user: Verify a User

View source: R/ndex_users.R

ndex_verify_userR Documentation

Verify a User

Description

Verify the given user with UUID and verification code, which is set by email

Usage

ndex_verify_user(ndexcon, userId, code)

Arguments

ndexcon

object of class NDExConnection linkndex_connect

userId

character; unique ID of the user

code

character; Verification code sent by email

Value

string "User account XXX has been activated." when this user's account is successfully activated.

REST query

GET: ndex_config$api$user$verify

Note

Compatible to NDEx server version 2.0

Examples

## Establish a server connection
# ndexcon = ndex_connect()
## Find user and get its id
# user = ndex_find_user_byName(ndexcon, 'SomeUserName')
# userId = user$externalId
## Verify user with verification code
# ndex_verify_user(ndexcon, userId, 'Osqy11mRZ9')
## [1] "User account XXX has been activated."
NULL

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