logOff


Purpose

Logs the user out of the Pega Platform instance and calls the LogOut activity on the server to close the session on the server side.

In oauth2 mode, calling this method results in Pega Mobile Client deleting all current access and refresh tokens.

Signature

logOff()

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 © 2018 and Confidential to Pegasystems Inc. All rights reserved
PDN | Feedback
Advanced...