logIn


Purpose

Attempts to authenticate the user.

Signature

logIn( username, password )

Parameters

The table below describes the logIn method parameters.

Name Description Type Use
username The name of the user that is being authenticated. string required
password The password for the user that is being authenticated. string required

Returns

This method returns a promise object, which can be in one of the following states:

  • Resolve - confirms that the operation has completed successfully.

  • Reject - returns an object that is an instance of a generic Error class, as described below.

    {
      "name": error_code
      "message": detailed_message
    }

Where error_code stands for one of the error codes described in the Constants section of the Authentication article and detailed_message can be an additional message from the native side.

Related topics

PegaAuthenticator
Legal notice | Copyright © 2019 and Confidential to Pegasystems Inc. All rights reserved
Pega Community | Feedback
Advanced...