remove


Purpose

Removes credentials saved on a device.

Signature

remove( username, password )

Parameters

The table below describes the remove method parameters.

Name Description Type Use
username The name of the user that is being removed. string required
password The password for the user that is being removed. 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 a JSON object with an error, as described below.

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

Where error_code stands for one of the following error codes: "AuthenticationInvalidCredentialsError," "AuthenticationEntryAlreadyExistsError," "AuthenticationEntryDoesNotExistError," "AuthenticationInternalError," "AuthenticationInvalidInputDataError," "AuthenticationNetworkError," "AuthenticationUnexpectedServerResponseError," "AuthenticationWrongClientVersionError," and detailed_message can be an additional message from the native side.

Related topics

CredentialsLockAuthenticator
Legal notice | Copyright © 2016 and Confidential to Pegasystems Inc. All rights reserved
PDN | Hybrid Container | Feedback
Advanced...