motusAuthenticateUser: authenticate a user with motus.org

View source: R/motusAuthenticateUser.R

motusAuthenticateUserR Documentation

authenticate a user with motus.org

Description

authenticate a user with motus.org

Usage

motusAuthenticateUser(username, password)

Arguments

username

motus user name

password

motus password (plaintext)

Value

if the credentials are valid, a list with these items:

  • token character scalar token used in subsequent API calls

  • expiry numeric timestamp at which token expires

  • userID integer user ID of user at motus

  • projects list of projects user has access to; indexed by integer projectID, values are project names

  • receivers FIXME: will be list of receivers user has access to

Otherwise, generate an error.

Note

This function uses the global AuthDB, defined in serverCommon

Author(s)

John Brzustowski jbrzusto@REMOVE_THIS_PART_fastmail.fm


MotusWTS/motusServer documentation built on Aug. 8, 2024, 10:23 p.m.