node-echo v0.1.9

Display Filters

class UsersAPI

Users API for Echo

Constructor

Constructor Parameters Returns
UsersAPI( parameters )

Parameters:

  • parameters <Object> object for options
    • parameters.consumerKey
    • parameters.consumerSecret
    • parameters.authMethod : optional, in ['oauth','basic']. Default 'oauth'

Methods

Methods Returns Description
get( id, callback ) void ↑ Fetch user information

Parameters:

  • id <string> user identityURL
  • callback <function> callback
update( user, callback ) void ↑ Update user information

Parameters:

  • user <object> user to update. Need to specify:
    • user.identityURL : User identity URL
    • user.subject : show which parameters should be updated
    • user.content : contains data to be used for user update
  • callback <function> callback
whoAmI( user ) void ↑ Retrieve currently logged in user information by session ID

Parameters:

  • user <object> : info for the user. Need to specify:
    • user.appKey : customer appKey
    • user.sessionID : Backplane sessions ID for this user