Exposed APIs of the Orchestration SDK: Change Password

New APIs are created for Swift users of the iOS SDK. For more information, refer to the Xcode API documentation on ChangePasswordParameters and ChangePasswordDelegate.

The Customer Mobile Application can initialize a change password process by calling the startChangePassword method of the Orchestrator object.

A ChangePasswordParams object must be provided as an input parameter of the startChangePassword method.

The ChangePasswordParams object must be initiated with the following parameters:

• User identifier. A string which uniquely identifies the user on the OneSpan Trusted Identity platform.

• Cryptographic Application Index: The index of the cryptographic application which must be used to generate the OTP.

• An object implementing the ChangePasswordCallback interface.

The ChangePasswordCallback interface is used by the Orchestration SDK to interact with the Customer Mobile Application during the change password process. It exposes the following methods:

• onChangePasswordStepComplete. Called when a step of the change password process is complete. The provided orchestration command must be sent to the server.

• onChangePasswordSuccess. Called upon successful change of the password.

• onChangePasswordAborted. Called when changing the password is cancelled.

• onChangePasswordInputError. Called upon an error in the change password process due to incorrect user input. The possible errors are listed in the OrchestrationErrorCodes class.

For more information about this feature, see Change password.