ndex_user_forgot_password: Forgot Password

View source: R/ndex_users.R

ndex_user_forgot_passwordR Documentation

Forgot Password

Description

Causes a new password to be generated for the given user account and then emailed to the user's emailAddress

Usage

ndex_user_forgot_password(ndexcon, userId)

Arguments

ndexcon

object of class NDExConnection linkndex_connect

userId

character; unique ID of the user

Value

Empty string on success, else error

REST query

GET: ndex_config$api$user$password$mail Wrapper for ndex_user_mail_password()

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
## Request new password via email
# ndex_user_forgot_password(ndexcon, userId)
NULL

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