synapseLogin: Authentication

Description Usage Arguments Details Author(s)

Description

Functions for handling Synapse authentication.

Usage

1
2
3
4
synapseLogin(username, password, mode = "auth")
synapseLogout(localOnly=FALSE)
.getUsername
.getPassword()

Arguments

username

Synapse username

password

API password associated with the username (see details)

localOnly

boolean controlling whether logout is done locally only, or propagated to Synapse

mode

The authentication mode. either "auth" or "hmac"

Details

If username and/or password arguments are not provided, the user will be prompted for input. If logout is propagated to Synapse (ie. localOnly = TRUE), it is likely that the user will be logged out for all clients currently in use

Author(s)

Matt Furia


Sage-Bionetworks/rSynapseClientRewrite documentation built on May 9, 2019, 7:06 p.m.