Logout

This logout endpoint terminates the current session. As a result, the customer's authentication will be terminated, and it will be required to obtain a new access token in order to make further API calls.

TIP

The logout endpoint has been implemented in the Login Web Component, and It's all setup to save developer's time and effort.

Response

Success

Error

auth.logout.success

success

boolean

success

required

Response flag

status

enum<number>

status

required

Allowed values:

200201202

Usage

The method logout() can be called in order to process the logout request. It does not require any input.

Events

The logout process may trigger two events during the login process, onLoggedOut and onFailedLogout.

onLoggedOut

This event will be triggered when the logout process is completed successfully without errors.

onFailedLogout

This event will be triggered when the logout process is not completed, and an error has occurred.

Response#

Usage#

Events#

onLoggedOut#

onFailedLogout#

Response

Usage

Events

onLoggedOut

onFailedLogout