API Docs for:
Show:

LoopbackUserClient Class

Defined in: src/loopback-user-client.coffee:4
Module: loopback-promised

Loopback User Client to access to UserModel (or extenders)

see http://docs.strongloop.com/display/public/LB/PersistedModel+REST+API see also http://apidocs.strongloop.com/loopback/#persistedmodel

Item Index

Methods

Methods

confirm

(
  • userId
  • token
  • redirect
)
Promise(Object)

Defined in src/loopback-user-client.coffee:16

Confirm the user's identity.

Parameters:

  • userId String
  • token String

    The validation token

  • redirect String

    URL to redirect the user to once confirmed

Returns:

Promise(Object):

login

(
  • credentials
  • include
)
Promise(Object)

Defined in src/loopback-user-client.coffee:38

Login a user by with the given credentials

Parameters:

  • credentials Object

    email/password

  • include String

    Optionally set it to "user" to include the user info

Returns:

Promise(Object):

logout

(
  • accessTokenID
)
Promise

Defined in src/loopback-user-client.coffee:58

Logout a user with the given accessToken id.

Parameters:

  • accessTokenID String

Returns:

Promise:

resetPassword

(
  • email
)
Promise

Defined in src/loopback-user-client.coffee:75

Create a short lived acess token for temporary login. Allows users to change passwords if forgotten.

Parameters:

  • email String

Returns:

Promise: